Use positive language in NOTE: and WARNING:
Documentation issue
Some NOTEs and WARNINGs use negative language, e.g. "Don't use ..." when it's not obvious what the use case of the feature is. This use positive language, describing what the feature is intended for.
Examples:
- Instead of "WARNING: Doing a luksFormat on an existing LUKS container will make all data the old container permanently irretrievable unless you have a header backup." use: "WARNING: Performing header backup before luksFormat avoids loosing access to the container permanently."
- Instead of "WARNING: never suspend the device on which the cryptsetup binary resides." explain what happens if someone does.
- For "NOTE: with --unbound option the action creates new unbound LUKS2 keyslot. The keyslot cannot be used for device activation...." explain what
--unbound
is intended for. - Add a note about a header backup to "WARNING: This operation is irreversible." for
luksErase
. - This is very confusing: "Alternatively, if there is no LUKS header on the device, the backup will also be written to it." (
luksHeaderRestore
) - This is also unclear: "The action token remove removes any token type, not just keyring type from token slot specified by --token-id option."
- For "WARNING: Always create a binary backup of the original header before calling this command." explain how to do that (
repair
).
Additional info
cryptsetup 2.0.6