Skip to contentSkip to conversation

dm-verity: Document restart_on_error and panic_on_error options

PATCH New Milan Broz 1 participant 3 messages Jan 29, 2025

Subsystems (2)
lore
Share & tools
lore

Milan Broz

author
#0 lore raw

PATCH 1/3 dm-verity: Document restart_on_error and panic_on_error options

This patch adds documentation for options introduced in commit f811b83879fb ("dm-verity: introduce the options restart_on_error and panic_on_error").

---
 Documentation/admin-guide/device-mapper/verity.rst | 9 +++++++++
 1 file changed, 9 insertions(+)
Documentation/admin-guide/device-mapper/verity.rst +9 -0
index a65c1602cb23..fb3a045d0c72 100644
@@ -87,6 +87,15 @@ panic_on_corruption
     Panic the device when a corrupted block is discovered. This option is
     not compatible with ignore_corruption and restart_on_corruption.
 
+restart_on_error
+    Restart the system when an I/O error is detected.
+    This option can be combined with the restart_on_corruption option.
+
+panic_on_error
+    Panic the device when an I/O error is detected. This option is
+    not compatible with the restart_on_error option but can be combined
+    with the panic_on_corruption option.
+
 ignore_zero_blocks
     Do not verify blocks that are expected to contain zeroes and always return
     zeroes instead. This may be useful if the partition contains unused blocks
Signature · 1 line
2.47.2
author
#1 lore raw

PATCH 2/3 dm-integrity: Document Inline mode for storing integrity data

This patch adds documentation for new 'I' mode for dm-integrity introduced in commit
fb0987682c62 ("dm-integrity: introduce the Inline mode").

---
 Documentation/admin-guide/device-mapper/dm-integrity.rst | 5 +++++
 1 file changed, 5 insertions(+)
Documentation/admin-guide/device-mapper/dm-integrity.rst +5 -0
index d8a5f14d0e3c..c2e18ecc065c 100644
@@ -92,6 +92,11 @@ Target arguments:
 		allowed. This mode is useful for data recovery if the
 		device cannot be activated in any of the other standard
 		modes.
+	I - inline mode - in this mode, dm-integrity will store integrity
+		data directly in the underlying device sectors.
+		The underlying device must have an integrity profile that
+		allows storing user integrity data and provides enough
+		space for the selected integrity tag.
 
 5. the number of additional arguments
 
Signature · 1 line
2.47.2
author
#2 lore raw

PATCH 3/3 dm-crypt: Document integrity_key_size option.

In reply to Milan Broz

This patch adds documentation for new option introduced in commit 4441686b24a1 ("dm-crypt: Allow to specify the integrity key size as option").

---
 Documentation/admin-guide/device-mapper/dm-crypt.rst | 5 +++++
 1 file changed, 5 insertions(+)
Documentation/admin-guide/device-mapper/dm-crypt.rst +5 -0
index 9f8139ff97d6..4467f6d4b632 100644
@@ -146,6 +146,11 @@ integrity:<bytes>:<type>
     integrity for the encrypted device. The additional space is then
     used for storing authentication tag (and persistent IV if needed).
 
+integrity_key_size:<bytes>
+    Optionally set the integrity key size if it differs from the digest size.
+    It allows the use of wrapped key algorithms where the key size is
+    independent of the cryptographic key size.
+
 sector_size:<bytes>
     Use <bytes> as the encryption unit instead of 512 bytes sectors.
     This option can be in range 512 - 4096 bytes and must be power of two.
Signature · 1 line
2.47.2