Use custom admonitions for bugs and wishlist items
Marco Ricci

Marco Ricci commited on 2025-06-21 15:24:09
Zeige 24 geänderte Dateien mit 26 Einfügungen und 30 Löschungen.


This was previously set up in b3586b484afae50aa7c55a95ec5f62f94263810a.
... ...
@@ -1,6 +1,6 @@
1 1
 # `derivepassphrase` bug allow-all-unicode-passphrases
2 2
 
3
-???+ success "Bug details: Allow all Unicode text strings as master passphrases"
3
+???+ bug-success "Bug details: Allow all Unicode text strings as master passphrases"
4 4
     <table id="bug-summary" markdown>
5 5
         <tr><th scope=col>Class<td><i>bug</i><td>This is clearly an actual problem we want fixed.
6 6
         <tr><th scope=col>Present-in<td colspan=2>0.1.0 0.1.1 0.1.2 <b>0.1.3</b>
... ...
@@ -1,6 +1,6 @@
1 1
 # `derivepassphrase` bug amend-vault-config
2 2
 
3
-???+ success "Bug details: `derivepassphrase vault --import` overwrites config instead of amending it"
3
+???+ bug-success "Bug details: `derivepassphrase vault --import` overwrites config instead of amending it"
4 4
     <table id="bug-summary" markdown>
5 5
         <tr><th scope=col>Class<td><i>bug</i><td>This is clearly an actual problem we want fixed.
6 6
         <tr><th scope=col>Present-in<td colspan=2>0.1.0 0.1.1 0.1.2 <b>0.2.0</b>
... ...
@@ -1,6 +1,6 @@
1 1
 # `derivepassphrase` bug better-error-messages
2 2
 
3
-???+ success "Bug details: Improve common error messages in the command-line interface"
3
+???+ bug-success "Bug details: Improve common error messages in the command-line interface"
4 4
     <table id="bug-summary" markdown>
5 5
         <tr><th scope=col>Class<td><i>bug</i><td>This is clearly an actual problem we want fixed.
6 6
         <tr><th scope=col>Present-in<td colspan=2>0.1.0 0.1.1 <b>0.1.2</b> 0.1.3
... ...
@@ -1,6 +1,6 @@
1 1
 # `derivepassphrase` bug concurrency-audit
2 2
 
3
-???+ success "Bug details: Audit `derivepassphrase` for concurrency/thread-safety issues"
3
+???+ bug-success "Bug details: Audit `derivepassphrase` for concurrency/thread-safety issues"
4 4
     <table id="bug-summary" markdown>
5 5
         <tr><th scope=col>Class<td><i>bug</i><td>This is clearly an actual problem we want fixed.
6 6
         <tr><th scope=col>Priority<td><i>high</i><td>This should be fixed in the next release.
... ...
@@ -1,6 +1,6 @@
1 1
 # `derivepassphrase` bug concurrency-testing-in-test-suite
2 2
 
3
-???+ success "Bug details: Test for concurrency and assert thread-safety in `derivepassphrase`&apos;s test suite"
3
+???+ bug-success "Bug details: Test for concurrency and assert thread-safety in `derivepassphrase`&apos;s test suite"
4 4
     <table id="bug-summary" markdown>
5 5
         <tr><th scope=col>Class<td><i>bug</i><td>This is clearly an actual problem we want fixed.
6 6
         <tr><th scope=col>Priority<td><i>high</i><td>This should be fixed in the next release.
... ...
@@ -1,6 +1,6 @@
1 1
 # `derivepassphrase` bug configuration-directory-must-exist
2 2
 
3
-???+ success "Bug details: `derivepassphrase --config` requires configuration directory to exist"
3
+???+ bug-success "Bug details: `derivepassphrase --config` requires configuration directory to exist"
4 4
     <table id="bug-summary" markdown>
5 5
         <tr><th scope=col>Class<td><i>bug</i><td>This is clearly an actual problem we want fixed.
6 6
         <tr><th scope=col>Present-in<td colspan=2>0.1.0 0.1.1 <b>0.1.2</b>
... ...
@@ -1,6 +1,6 @@
1 1
 # `derivepassphrase` wish conventional-configurable-text-styling
2 2
 
3
-???+ question "Wish details: `derivepassphrase vault` should support conventional and configurable text styling"
3
+???+ wish "Wish details: `derivepassphrase vault` should support conventional and configurable text styling"
4 4
     <table id="bug-summary" markdown>
5 5
         <tr><th scope=col>Class<td><i>wish</i><td>This is a request for an enhancement.
6 6
         <tr><th scope=col>Priority<td><i>low</i><td>We aren&apos;t sure whether to fix this or not.
... ...
@@ -1,6 +1,6 @@
1 1
 # `derivepassphrase` wish export-vault-formats
2 2
 
3
-???+ success "Wish details: Support data export from vault v0.2, vault v0.3, and storeroom storage formats"
3
+???+ wish-success "Wish details: Support data export from vault v0.2, vault v0.3, and storeroom storage formats"
4 4
     <table id="bug-summary" markdown>
5 5
         <tr><th scope=col>Class<td><i>wish</i><td>This is a request for an enhancement.
6 6
         <tr><th scope=col>Present-in<td colspan=2>0.1.0 0.1.1 <b>0.1.2</b> 0.1.3
... ...
@@ -1,6 +1,6 @@
1 1
 # `derivepassphrase` wish exporter-script-as-subcommand
2 2
 
3
-???+ success "Wish details: Make the exporter a subcommand of `derivepassphrase`"
3
+???+ wish-success "Wish details: Make the exporter a subcommand of `derivepassphrase`"
4 4
     <table id="bug-summary" markdown>
5 5
         <tr><th scope=col>Class<td><i>wish</i><td>This is a request for an enhancement.
6 6
         <tr><th scope=col>Present-in<td colspan=2><a href="https://github.com/the-13th-letter/derivepassphrase/commit/b4d8439fa4207b665ad8ea2217f21f807f603734">b4d8439fa4207b665ad8ea2217f21f807f603734</a> (0.2.0)
... ...
@@ -1,6 +1,6 @@
1 1
 # `derivepassphrase` bug fail-gracefully-without-af-unix
2 2
 
3
-???+ success "Bug details: Fail gracefully if support for UNIX domain sockets is unavailable"
3
+???+ bug-success "Bug details: Fail gracefully if support for UNIX domain sockets is unavailable"
4 4
     <table id="bug-summary" markdown>
5 5
         <tr><th scope=col>Class<td><i>bug</i><td>This is clearly an actual problem we want fixed.
6 6
         <tr><th scope=col>Present-in<td colspan=2>0.1.0 0.1.1 0.1.2 <b>0.2.0</b>
... ...
@@ -1,6 +1,6 @@
1 1
 # `derivepassphrase` bug falsy-vault-config-values
2 2
 
3
-???+ success "Bug details: `derivepassphrase vault` differs from vault(1) behavior with falsy stored configuration values"
3
+???+ bug-success "Bug details: `derivepassphrase vault` differs from vault(1) behavior with falsy stored configuration values"
4 4
     <table id="bug-summary" markdown>
5 5
         <tr><th scope=col>Class<td><i>bug</i><td>This is clearly an actual problem we want fixed.
6 6
         <tr><th scope=col>Present-in<td colspan=2>0.1.0 0.1.1 0.1.2 <b>0.2.0</b>
... ...
@@ -10,11 +10,11 @@
10 10
 ???+ bug "things to fix"
11 11
       - [windows-ssh-agent-support][]{: .scheduled-next }
12 12
 
13
-???+ question "things to add"
13
+???+ wish "things to add"
14 14
       - [conventional-configurable-text-styling][]{: .unscheduled }
15 15
       - [other-derivation-schemes][]{: .unscheduled }
16 16
 
17
-??? success "fixed things"
17
+??? bug-success "things fixed"
18 18
       - [allow-all-unicode-passphrases][]{: .fixed }
19 19
       - [amend-vault-config][]{: .fixed }
20 20
       - [better-error-messages][]{: .fixed }
... ...
@@ -30,7 +30,7 @@
30 30
       - [single-toplevel-module][]{: .fixed }
31 31
       - [test-filesystem-isolation][]{: .fixed }
32 32
 
33
-    ---
33
+??? wish-success "things added"
34 34
 
35 35
       - [export-vault-formats][]{: .fixed }
36 36
       - [exporter-script-as-subcommand][]{: .fixed }
... ...
@@ -40,10 +40,6 @@
40 40
       - [scheme-specific-cli-and-config][]{: .fixed }
41 41
       - [test-suite-isolated-ssh-agent][]{: .fixed }
42 42
 
43
-!!! abstract "Further reading"
44
-
45
-    → Scheduled bugs and wishes
46
-
47 43
   [allow-all-unicode-passphrases]: allow-all-unicode-passphrases.md
48 44
   [amend-vault-config]: amend-vault-config.md
49 45
   [better-error-messages]: better-error-messages.md
... ...
@@ -1,6 +1,6 @@
1 1
 # `derivepassphrase` bug no-stdlib-module-names
2 2
 
3
-???+ success "Bug details: Rename `types` submodules to `_types`"
3
+???+ bug-success "Bug details: Rename `types` submodules to `_types`"
4 4
     <table id="bug-summary" markdown>
5 5
         <tr><th scope=col>Class<td><i>bug</i><td>This is clearly an actual problem we want fixed.
6 6
         <tr><th scope=col>Present-in<td colspan=2>0.1.0 0.1.1 <b>0.1.2</b> 0.1.3
... ...
@@ -1,6 +1,6 @@
1 1
 # `derivepassphrase` bug one-time-key-override-fails
2 2
 
3
-???+ success "Bug details: `derivepassphrase -k` fails when overriding the chosen key on the command-line"
3
+???+ bug-success "Bug details: `derivepassphrase -k` fails when overriding the chosen key on the command-line"
4 4
     <table id="bug-summary" markdown>
5 5
         <tr><th scope=col>Class<td><i>bug</i><td>This is clearly an actual problem we want fixed.
6 6
         <tr><th scope=col>Present-in<td colspan=2>0.1.0 0.1.1 <b>0.1.2</b>
... ...
@@ -1,6 +1,6 @@
1 1
 # `derivepassphrase` wish other-derivation-schemes
2 2
 
3
-???+ question "Wish details: Consider implementing passphrase schemes other than vault&apos;s"
3
+???+ wish "Wish details: Consider implementing passphrase schemes other than vault&apos;s"
4 4
     <table id="bug-summary" markdown>
5 5
         <tr><th scope=col>Class<td><i>wish</i><td>This is a request for an enhancement.
6 6
         <tr><th scope=col>Priority<td><i>medium</i><td>This should be fixed one day.
... ...
@@ -1,6 +1,6 @@
1 1
 # `derivepassphrase` wish pretty-print-json
2 2
 
3
-???+ success "Wish details: `derivepassphrase vault` should store and export the vault configuration in pretty-printed JSON"
3
+???+ wish-success "Wish details: `derivepassphrase vault` should store and export the vault configuration in pretty-printed JSON"
4 4
     <table id="bug-summary" markdown>
5 5
         <tr><th scope=col>Class<td><i>wish</i><td>This is a request for an enhancement.
6 6
         <tr><th scope=col>Present-in<td colspan=2>0.1.0 0.1.1 0.1.2 0.2.0 0.3.0 0.3.1 0.3.2 0.3.3 <b>0.4.0</b>
... ...
@@ -1,6 +1,6 @@
1 1
 # `derivepassphrase` wish print-service-notes-above
2 2
 
3
-???+ success "Wish details: `derivepassphrase vault` should be able to print service notes *above* the passphrase"
3
+???+ wish-success "Wish details: `derivepassphrase vault` should be able to print service notes *above* the passphrase"
4 4
     <table id="bug-summary" markdown>
5 5
         <tr><th scope=col>Class<td><i>wish</i><td>This is a request for an enhancement.
6 6
         <tr><th scope=col>Present-in<td colspan=2><b>0.4.0</b>
... ...
@@ -1,6 +1,6 @@
1 1
 # `derivepassphrase` bug print-service-notes
2 2
 
3
-???+ success "Bug details: `derivepassphrase vault` does not print service notes"
3
+???+ bug-success "Bug details: `derivepassphrase vault` does not print service notes"
4 4
     <table id="bug-summary" markdown>
5 5
         <tr><th scope=col>Class<td><i>bug</i><td>This is clearly an actual problem we want fixed.
6 6
         <tr><th scope=col>Present-in<td colspan=2>0.1.0 0.1.1 0.1.2 0.2.0 0.3.0 0.3.1 0.3.2 0.3.3 <b>0.4.0</b>
... ...
@@ -1,6 +1,6 @@
1 1
 # `derivepassphrase` bug remove-pageant-build-info-check
2 2
 
3
-???+ success "Bug details: Remove Pageant build info check"
3
+???+ bug-success "Bug details: Remove Pageant build info check"
4 4
     <table id="bug-summary" markdown>
5 5
         <tr><th scope=col>Class<td><i>bug</i><td>This is clearly an actual problem we want fixed.
6 6
         <tr><th scope=col>Present-in<td colspan=2><b>0.2.0</b> 0.3.0 0.3.1 0.3.2 0.3.3
... ...
@@ -1,6 +1,6 @@
1 1
 # `derivepassphrase` wish report-build-flags-and-features
2 2
 
3
-???+ success "Wish details: `derivepassphrase` should report its build flags and supported features"
3
+???+ wish-success "Wish details: `derivepassphrase` should report its build flags and supported features"
4 4
     <table id="bug-summary" markdown>
5 5
         <tr><th scope=col>Class<td><i>wish</i><td>This is a request for an enhancement.
6 6
         <tr><th scope=col>Present-in<td colspan=2>0.1.0 0.1.1 0.1.2 0.2.0 0.3.0 0.3.1 0.3.2 0.3.3 <b>0.4.0</b>
... ...
@@ -1,6 +1,6 @@
1 1
 # `derivepassphrase` wish scheme-specific-cli-and-config
2 2
 
3
-???+ success "Wish details: Move `vault`-specific command-line interface into a separate CLI subcommand and matching configuration file"
3
+???+ wish-success "Wish details: Move `vault`-specific command-line interface into a separate CLI subcommand and matching configuration file"
4 4
     <table id="bug-summary" markdown>
5 5
         <tr><th scope=col>Class<td><i>wish</i><td>This is a request for an enhancement.
6 6
         <tr><th scope=col>Present-in<td colspan=2>0.1.0 0.1.1 0.1.2 0.1.3 <b>0.2.0</b>
... ...
@@ -1,6 +1,6 @@
1 1
 # `derivepassphrase` bug single-toplevel-module
2 2
 
3
-???+ success "Bug details: Move `sequin` and `ssh_agent_client` modules into `derivepassphrase` package"
3
+???+ bug-success "Bug details: Move `sequin` and `ssh_agent_client` modules into `derivepassphrase` package"
4 4
     <table id="bug-summary" markdown>
5 5
         <tr><th scope=col>Class<td><i>bug</i><td>This is clearly an actual problem we want fixed.
6 6
         <tr><th scope=col>Present-in<td colspan=2>0.1.0 0.1.1 <b>0.1.2</b> 0.1.3
... ...
@@ -1,6 +1,6 @@
1 1
 # `derivepassphrase` bug test-filesystem-isolation
2 2
 
3
-???+ success "Bug details: Isolate tests properly from the filesystem"
3
+???+ bug-success "Bug details: Isolate tests properly from the filesystem"
4 4
     <table id="bug-summary" markdown>
5 5
         <tr><th scope=col>Class<td><i>bug</i><td>This is clearly an actual problem we want fixed.
6 6
         <tr><th scope=col>Present-in<td colspan=2>0.1.0 0.1.1 <b>0.1.2</b>
... ...
@@ -1,6 +1,6 @@
1 1
 # `derivepassphrase` wish test-suite-isolated-ssh-agent
2 2
 
3
-???+ success "Wish details: Support and isolate OpenSSH&apos;s `ssh-agent` and PuTTY&apos;s `pageant` in the test suite"
3
+???+ wish-success "Wish details: Support and isolate OpenSSH&apos;s `ssh-agent` and PuTTY&apos;s `pageant` in the test suite"
4 4
     <table id="bug-summary" markdown>
5 5
         <tr><th scope=col>Class<td><i>wish</i><td>This is a request for an enhancement.
6 6
         <tr><th scope=col>Present-in<td colspan=2>0.1.0 0.1.1 0.1.2 0.1.3 <b>0.2.0</b>
7 7