Document recent changes to notes handling in the changelog
Marco Ricci commited on 2025-02-07 19:09:54
Zeige 1 geänderte Dateien mit 41 Einfügungen und 0 Löschungen.
- docs/changelog.d/20250207_182820_the-13th-letter_notes_handling.md 0000000..bbc7d88
| ... | ... |
@@ -0,0 +1,41 @@ |
| 1 |
+### Added |
|
| 2 |
+ |
|
| 3 |
+ - `derivepassphrase vault` now supports selecting the editor interface |
|
| 4 |
+ when editing notes via the `--modern-editor-interface` and |
|
| 5 |
+ `--vault-legacy-editor-interface` options. |
|
| 6 |
+ |
|
| 7 |
+ - `derivepassphrase vault` now supports printing the service notes before |
|
| 8 |
+ the passphrase, as an alternative, instead of always printing them |
|
| 9 |
+ *after* the passphrase. |
|
| 10 |
+ |
|
| 11 |
+ - The tests concerning `derivepassphrase vault` and `--notes` usage have |
|
| 12 |
+ been rewritten into [hypothesis][]-based tests where feasible. |
|
| 13 |
+ |
|
| 14 |
+[hypothesis]: https://pypi.org/project/hypothesis/ |
|
| 15 |
+ |
|
| 16 |
+### Changed |
|
| 17 |
+ |
|
| 18 |
+ - `derivepassphrase vault` now correctly requires the `--config` option in |
|
| 19 |
+ addition to the `--notes` option to request that the service notes be |
|
| 20 |
+ edited, for compatibility with vault(1). `notes` is now also a valid |
|
| 21 |
+ setting name for `--unset` to take. Furthermore, editing the notes |
|
| 22 |
+ successfully in any way, including no-op edits, will register the |
|
| 23 |
+ service name as a known service to `derivepassphrase vault`, even if the |
|
| 24 |
+ settings are otherwise empty. Finally, using plain `--notes` without |
|
| 25 |
+ `--config` has no effect, and issues a warning to that extent. |
|
| 26 |
+ |
|
| 27 |
+ - `derivepassphrase vault` by default now uses an editor interface that |
|
| 28 |
+ matches vault(1): the contents of the edited text file are used directly |
|
| 29 |
+ as the service notes, without interpretation. Previously, we |
|
| 30 |
+ post-processed the text file to remove comments and our instruction |
|
| 31 |
+ texts, and interpreted an empty file as a request to abort the edit. |
|
| 32 |
+ These two editor interfaces ("legacy" and "modern") can be explicitly
|
|
| 33 |
+ selected, and for the legacy interface, which is less resilient against |
|
| 34 |
+ data entry or usage errors, a backup copy of the old notes content is |
|
| 35 |
+ made. |
|
| 36 |
+ |
|
| 37 |
+### Fixed |
|
| 38 |
+ |
|
| 39 |
+ - `derivepassphrase vault` now also prints the service notes (if any) when |
|
| 40 |
+ deriving a service passphrase, just like vault(1) does. |
|
| 41 |
+ |
|
| 0 | 42 |