From bc1b149ee4083e6736be8c8ed9fd4dd13ea3513c Mon Sep 17 00:00:00 2001 From: Milan Broz Date: Wed, 23 Jul 2025 11:31:11 +0200 Subject: [PATCH] man: Better mark option --align-payload as deprecated. --- man/common_options.adoc | 4 ++-- man/cryptsetup-luksFormat.8.adoc | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/man/common_options.adoc b/man/common_options.adoc index 35c62b12..2a142d86 100644 --- a/man/common_options.adoc +++ b/man/common_options.adoc @@ -1,7 +1,7 @@ == OPTIONS ifdef::ACTION_LUKSFORMAT,ACTION_REENCRYPT[] -*--align-payload* __:: +*--align-payload* __ (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::[] diff --git a/man/cryptsetup-luksFormat.8.adoc b/man/cryptsetup-luksFormat.8.adoc index 7fe1317a..b0887d62 100644 --- a/man/cryptsetup-luksFormat.8.adoc +++ b/man/cryptsetup-luksFormat.8.adoc @@ -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. -** 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)]. +** 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 ** 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].