summaryrefslogtreecommitdiffstats
path: root/man/veritytab.xml
diff options
context:
space:
mode:
authorAbderrahim Kitouni <abderrahim.kitouni@codethink.co.uk>2023-08-22 18:52:36 +0200
committerAbderrahim Kitouni <abderrahim.kitouni@codethink.co.uk>2023-08-29 15:07:24 +0200
commitec07c3c80b2b1bfa6788500202006ff85f5ae4f4 (patch)
treeab6fb6ca9620a58fc32cdf3dba9b8a0f77d48d18 /man/veritytab.xml
parentman: Add xinclude namespace (diff)
downloadsystemd-ec07c3c80b2b1bfa6788500202006ff85f5ae4f4.tar.xz
systemd-ec07c3c80b2b1bfa6788500202006ff85f5ae4f4.zip
man: add version info
This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
Diffstat (limited to 'man/veritytab.xml')
-rw-r--r--man/veritytab.xml74
1 files changed, 57 insertions, 17 deletions
diff --git a/man/veritytab.xml b/man/veritytab.xml
index 557d13e1ed..55b3458257 100644
--- a/man/veritytab.xml
+++ b/man/veritytab.xml
@@ -63,56 +63,72 @@ This is based on crypttab(5).
<varlistentry>
<term><option>superblock=<replaceable>BOOL</replaceable></option></term>
- <listitem><para>Use dm-verity with or without permanent on-disk superblock.</para></listitem>
+ <listitem><para>Use dm-verity with or without permanent on-disk superblock.</para>
+
+ <xi:include href="version-info.xml" xpointer="v254"/></listitem>
</varlistentry>
<varlistentry>
<term><option>format=<replaceable>NUMBER</replaceable></option></term>
<listitem><para>Specifies the hash version type. Format type 0 is original Chrome OS version. Format type 1 is
- modern version.</para></listitem>
+ modern version.</para>
+
+ <xi:include href="version-info.xml" xpointer="v254"/></listitem>
</varlistentry>
<varlistentry>
<term><option>data-block-size=<replaceable>BYTES</replaceable></option></term>
<listitem><para>Used block size for the data device. (Note kernel supports only page-size as maximum
- here; Multiples of 512 bytes.) </para></listitem>
+ here; Multiples of 512 bytes.) </para>
+
+ <xi:include href="version-info.xml" xpointer="v254"/></listitem>
</varlistentry>
<varlistentry>
<term><option>hash-block-size=<replaceable>BYTES</replaceable></option></term>
<listitem><para>Used block size for the hash device. (Note kernel supports only page-size as maximum
- here; Multiples of 512 bytes.)</para></listitem>
+ here; Multiples of 512 bytes.)</para>
+
+ <xi:include href="version-info.xml" xpointer="v254"/></listitem>
</varlistentry>
<varlistentry>
<term><option>data-blocks=<replaceable>BLOCKS</replaceable></option></term>
<listitem><para>Number of blocks of data device used in verification. If not specified, the whole device is
- used.</para></listitem>
+ used.</para>
+
+ <xi:include href="version-info.xml" xpointer="v254"/></listitem>
</varlistentry>
<varlistentry>
<term><option>hash-offset=<replaceable>BYTES</replaceable></option></term>
<listitem><para>Offset of hash area/superblock on <literal>hash-device</literal>. (Multiples of 512 bytes.)
- </para></listitem>
+ </para>
+
+ <xi:include href="version-info.xml" xpointer="v254"/></listitem>
</varlistentry>
<varlistentry>
<term><option>salt=<replaceable>HEX</replaceable></option></term>
<listitem><para>Salt used for format or verification. Format is a hexadecimal string; 256 bytes long maximum;
- <literal>-</literal>is the special value for empty.</para></listitem>
+ <literal>-</literal>is the special value for empty.</para>
+
+ <xi:include href="version-info.xml" xpointer="v254"/></listitem>
</varlistentry>
<varlistentry>
<term><option>uuid=<replaceable>UUID</replaceable></option></term>
<listitem><para>Use the provided UUID for format command instead of generating new one. The UUID must be
- provided in standard UUID format, e.g. 12345678-1234-1234-1234-123456789abc.</para></listitem>
+ provided in standard UUID format, e.g. 12345678-1234-1234-1234-123456789abc.</para>
+
+ <xi:include href="version-info.xml" xpointer="v254"/></listitem>
<listitem><para></para></listitem>
</varlistentry>
@@ -126,7 +142,9 @@ This is based on crypttab(5).
corruption is only logged. With <literal>--restart-on-corruption</literal> or
<literal>--panic-on-corruption</literal> the kernel is restarted (panicked) immediately.
- (You have to provide way how to avoid restart loops.)</para></listitem>
+ (You have to provide way how to avoid restart loops.)</para>
+
+ <xi:include href="version-info.xml" xpointer="v248"/></listitem>
</varlistentry>
<varlistentry>
@@ -136,7 +154,9 @@ This is based on crypttab(5).
return zeroes instead.
WARNING: Use this option only in very specific cases. This option is available since Linux kernel version 4.5.
- </para></listitem>
+ </para>
+
+ <xi:include href="version-info.xml" xpointer="v248"/></listitem>
</varlistentry>
<varlistentry>
@@ -147,14 +167,18 @@ This is based on crypttab(5).
WARNING: It provides a reduced level of security because only offline tampering of the data device's content
will be detected, not online tampering. This option is available since Linux kernel version 4.17.
- </para></listitem>
+ </para>
+
+ <xi:include href="version-info.xml" xpointer="v248"/></listitem>
</varlistentry>
<varlistentry>
<term><option>hash=<replaceable>HASH</replaceable></option></term>
<listitem><para>Hash algorithm for dm-verity. This should be the name of the algorithm, like "sha1". For default
- see <command>veritysetup --help</command>.</para></listitem>
+ see <command>veritysetup --help</command>.</para>
+
+ <xi:include href="version-info.xml" xpointer="v254"/></listitem>
</varlistentry>
<varlistentry>
@@ -163,14 +187,18 @@ This is based on crypttab(5).
<listitem><para>Use forward error correction (FEC) to recover from corruption if hash verification fails. Use
encoding data from the specified device. The fec device argument can be block device or file image. For format,
if fec device path doesn't exist, it will be created as file. Note: block sizes for data and hash devices must
- match. Also, if the verity data_device is encrypted the fec_device should be too.</para></listitem>
+ match. Also, if the verity data_device is encrypted the fec_device should be too.</para>
+
+ <xi:include href="version-info.xml" xpointer="v254"/></listitem>
</varlistentry>
<varlistentry>
<term><option>fec-offset=<replaceable>BYTES</replaceable></option></term>
<listitem><para>This is the offset, in bytes, from the start of the FEC device to the beginning of the encoding
- data. (Aligned on 512 bytes.)</para></listitem>
+ data. (Aligned on 512 bytes.)</para>
+
+ <xi:include href="version-info.xml" xpointer="v254"/></listitem>
</varlistentry>
<varlistentry>
@@ -178,6 +206,8 @@ This is based on crypttab(5).
<listitem><para>Number of generator roots. This equals to the number of parity bytes in the encoding data. In
RS(M, N) encoding, the number of roots is M-N. M is 255 and M-N is between 2 and 24 (including).</para>
+
+ <xi:include href="version-info.xml" xpointer="v254"/>
</listitem>
</varlistentry>
@@ -186,7 +216,9 @@ This is based on crypttab(5).
<listitem><para>A base64 string encoding the root hash signature prefixed by <literal>base64:</literal> or a
path to roothash signature file used to verify the root hash (in kernel). This feature requires Linux kernel
- version 5.4 or more recent.</para></listitem>
+ version 5.4 or more recent.</para>
+
+ <xi:include href="version-info.xml" xpointer="v251"/></listitem>
</varlistentry>
<varlistentry>
@@ -208,6 +240,8 @@ This is based on crypttab(5).
will be pulled in by <filename>local-fs.target</filename>, while the
service to configure the network is usually only started <emphasis>after</emphasis>
the local file system has been mounted.</para>
+
+ <xi:include href="version-info.xml" xpointer="v248"/>
</listitem>
</varlistentry>
@@ -218,7 +252,9 @@ This is based on crypttab(5).
This means that it will not be automatically enabled on boot, unless something else pulls
it in. In particular, if the device is used for a mount point, it'll be enabled
automatically during boot, unless the mount point itself is also disabled with
- <option>noauto</option>.</para></listitem>
+ <option>noauto</option>.</para>
+
+ <xi:include href="version-info.xml" xpointer="v248"/></listitem>
</varlistentry>
<varlistentry>
@@ -230,7 +266,9 @@ This is based on crypttab(5).
unsuccessful. Note that other units that depend on the enabled device may still fail. In
particular, if the device is used for a mount point, the mount point itself also needs to
have the <option>nofail</option> option, or the boot will fail if the device is not enabled
- successfully.</para></listitem>
+ successfully.</para>
+
+ <xi:include href="version-info.xml" xpointer="v248"/></listitem>
</varlistentry>
<varlistentry>
@@ -249,6 +287,8 @@ This is based on crypttab(5).
<para>All other verity protected block devices that contain file systems mounted in the initrd should
use this option.</para>
+
+ <xi:include href="version-info.xml" xpointer="v248"/>
</listitem>
</varlistentry>