Documentation: dm-integrity: Document default values.
authorRussell Harmon <eatnumber1@gmail.com>
Mon, 5 Jun 2023 05:08:52 +0000 (22:08 -0700)
committerMike Snitzer <snitzer@kernel.org>
Thu, 22 Jun 2023 22:39:50 +0000 (18:39 -0400)
Signed-off-by: Russell Harmon <eatnumber1@gmail.com>
Signed-off-by: Mike Snitzer <snitzer@kernel.org>
Documentation/admin-guide/device-mapper/dm-integrity.rst

index 31f514675809e43114925bfb15d7dd00726b8a97..0241457c0027cb7b049d9a94943ff6b8285a2174 100644 (file)
@@ -102,7 +102,7 @@ journal_sectors:number
        device. If the device is already formatted, the value from the
        superblock is used.
 
-interleave_sectors:number
+interleave_sectors:number (default 32768)
        The number of interleaved sectors. This values is rounded down to
        a power of two. If the device is already formatted, the value from
        the superblock is used.
@@ -111,16 +111,16 @@ meta_device:device
        Don't interleave the data and metadata on the device. Use a
        separate device for metadata.
 
-buffer_sectors:number
-       The number of sectors in one buffer. The value is rounded down to
-       a power of two.
+buffer_sectors:number (default 128)
+       The number of sectors in one metadata buffer. The value is rounded
+       down to a power of two.
 
-journal_watermark:number
+journal_watermark:number (default 50)
        The journal watermark in percents. When the size of the journal
        exceeds this watermark, the thread that flushes the journal will
        be started.
 
-commit_time:number
+commit_time:number (default 10000)
        Commit time in milliseconds. When this time passes, the journal is
        written. The journal is also written immediately if the FLUSH
        request is received.
@@ -168,11 +168,10 @@ journal_mac:algorithm(:key)       (the key is optional)
        the journal. Thus, modified sector number would be detected at
        this stage.
 
-block_size:number
-       The size of a data block in bytes.  The larger the block size the
+block_size:number (default 512)
+       The size of a data block in bytes. The larger the block size the
        less overhead there is for per-block integrity metadata.
-       Supported values are 512, 1024, 2048 and 4096 bytes.  If not
-       specified the default block size is 512 bytes.
+       Supported values are 512, 1024, 2048 and 4096 bytes.
 
 sectors_per_bit:number
        In the bitmap mode, this parameter specifies the number of
@@ -291,7 +290,8 @@ The layout of the formatted block device:
     Each run contains:
 
        * tag area - it contains integrity tags. There is one tag for each
-         sector in the data area
+         sector in the data area. The size of this area is always 4KiB or
+         greater.
        * data area - it contains data sectors. The number of data sectors
          in one run must be a power of two. log2 of this value is stored
          in the superblock.