eessppeelllloo/cryptsetup
1
0
Fork 0
mirror of https://gitlab.com/cryptsetup/cryptsetup.git synced 2025-12-05 16:00:05 +01:00
Code Issues Packages Projects Releases Wiki Activity

man: Better mark option --align-payload as deprecated.

Browse Source
This commit is contained in:
Milan Broz
2025-07-23 11:31:11 +02:00
parent 55272bee98
commit bc1b149ee4
2 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
man/common_options.adoc
View File

@@ -1,7 +1,7 @@
== OPTIONS
ifdef::ACTION_LUKSFORMAT,ACTION_REENCRYPT[]
*--align-payload* _<number of 512 byte sectors>_::
*--align-payload* _<number of 512 byte sectors>_ (DEPRECATED, use --offset)::
Align payload at a boundary of _value_ 512-byte sectors.
+
If not specified, cryptsetup tries to use the topology info provided by the kernel for the underlying device to get the optimal alignment.
@@ -10,7 +10,7 @@ If not available (or the calculated value is a multiple of the default), data is
For a detached LUKS header, this option specifies the offset on the data device.
See also the --header option.
+
*WARNING:* This option is DEPRECATED and has an unexpected impact on the data offset and keyslot area size (for LUKS2) due to the complex rounding.
This option is DEPRECATED and has an unexpected impact on the data offset and keyslot area size (for LUKS2) due to the complex rounding.
For fixed data device offset, use --offset option instead.
endif::[]

2
man/cryptsetup-luksFormat.8.adoc
View File

@@ -29,7 +29,7 @@ To use OPAL hardware encryption on a self-encrypting drive, use --hw-opal or --h
Note that some OPAL drives can require a PSID reset (with deletion of data) before using the LUKS format with OPAL options.
See --hw-opal-factory-reset option in cryptsetup _erase_ command.
*<options>* can be [--hash, --cipher, --verify-passphrase, --key-size, --key-slot, --key-file (takes precedence over optional second argument), --keyfile-offset, --keyfile-size, --use-random, --use-urandom, --uuid, --volume-key-file, --iter-time, --header, --pbkdf-force-iterations, --force-password, --disable-locks, --timeout, --type, --offset, --align-payload (deprecated)].
*<options>* can be [--hash, --cipher, --verify-passphrase, --key-size, --key-slot, --key-file (takes precedence over optional second argument), --keyfile-offset, --keyfile-size, --use-random, --use-urandom, --uuid, --volume-key-file, --iter-time, --header, --pbkdf-force-iterations, --force-password, --disable-locks, --timeout, --type, --offset, --align-payload (DEPRECATED)].
For LUKS2, additional *<options>* can be [--integrity, --integrity-no-wipe, --sector-size, --label, --subsystem, --pbkdf, --pbkdf-memory, --pbkdf-parallel, --disable-locks, --disable-keyring, --luks2-metadata-size, --luks2-keyslots-size, --keyslot-cipher, --keyslot-key-size, --integrity-legacy-padding, --hw-opal, --hw-opal-only].