linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Russell Harmon <eatnumber1@gmail.com>
To: bagasdotme@gmail.com
Cc: mpatocka@redhat.com, snitzer@redhat.com, dm-devel@redhat.com,
	linux-doc@vger.kernel.org, Russell Harmon <eatnumber1@gmail.com>
Subject: [PATCH 3/4] Document dm-integrity default values.
Date: Sat,  3 Jun 2023 13:15:24 -0700	[thread overview]
Message-ID: <20230603201525.9409-4-eatnumber1@gmail.com> (raw)
In-Reply-To: <20230603201525.9409-1-eatnumber1@gmail.com>

Signed-off-by: Russell Harmon <eatnumber1@gmail.com>
---
 .../device-mapper/dm-integrity.rst            | 22 +++++++++----------
 1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/Documentation/admin-guide/device-mapper/dm-integrity.rst b/Documentation/admin-guide/device-mapper/dm-integrity.rst
index 31f514675809..0241457c0027 100644
--- a/Documentation/admin-guide/device-mapper/dm-integrity.rst
+++ b/Documentation/admin-guide/device-mapper/dm-integrity.rst
@@ -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.
-- 
2.34.1


  parent reply	other threads:[~2023-06-03 20:16 UTC|newest]

Thread overview: 33+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <20230530002032.15227-1-eatnumber1@gmail.com>
2023-06-03 12:45 ` [dm-devel] [PATCH] Improve the dm-integrity documentation Bagas Sanjaya
2023-06-03 20:15   ` Russell Harmon
2023-06-03 20:15     ` [PATCH 1/4] Fix minor grammatical error in dm-integrity.rst Russell Harmon
2023-06-03 20:15     ` [PATCH 2/4] Documents the meaning of "buffer" in dm-integrity Russell Harmon
2023-06-03 20:15     ` Russell Harmon [this message]
2023-06-03 20:15     ` [PATCH 4/4] Document an example of how the tunables relate " Russell Harmon
2023-06-04 14:07     ` [PATCH] Improve the dm-integrity documentation Bagas Sanjaya
2023-06-04 18:25       ` Russell Harmon
2023-06-04 19:06         ` [PATCH v3 0/4] " Russell Harmon
2023-06-04 19:06           ` [PATCH v3 1/4] Fix minor grammatical error in dm-integrity.rst Russell Harmon
2023-06-05  3:03             ` Bagas Sanjaya
2023-06-05  5:00               ` Russell Harmon
2023-06-04 19:06           ` [PATCH v3 2/4] Documents the meaning of "buffer" in dm-integrity Russell Harmon
2023-06-05  3:05             ` Bagas Sanjaya
2023-06-05  3:07             ` Bagas Sanjaya
2023-06-05  5:01               ` Russell Harmon
2023-06-04 19:06           ` [PATCH v3 3/4] Document dm-integrity default values Russell Harmon
2023-06-05  3:16             ` Bagas Sanjaya
2023-06-05  5:05               ` Russell Harmon
2023-06-05 13:23               ` Jonathan Corbet
2023-06-06  2:16                 ` Bagas Sanjaya
2023-06-04 19:06           ` [PATCH v3 4/4] Document an example of how the tunables relate in dm-integrity Russell Harmon
2023-06-05  3:17             ` Bagas Sanjaya
2023-06-05  5:05               ` Russell Harmon
2023-06-05  5:08           ` [PATCH v4 0/4] Improve the dm-integrity documentation Russell Harmon
2023-06-05  5:08             ` [PATCH v4 1/4] Documentation: dm-integrity: Fix minor grammatical error Russell Harmon
2023-06-06  2:17               ` Bagas Sanjaya
2023-06-05  5:08             ` [PATCH v4 2/4] Documentation: dm-integrity: Document the meaning of "buffer" Russell Harmon
2023-06-06  2:18               ` Bagas Sanjaya
2023-06-05  5:08             ` [PATCH v4 3/4] Documentation: dm-integrity: Document default values Russell Harmon
2023-06-05  5:08             ` [PATCH v4 4/4] Documentation: dm-integrity: Document an example of how the tunables relate Russell Harmon
2023-06-17 19:37               ` Russell Harmon
     [not found] ` <CA+zrezTKon+02mfMRsW34Tkovqn3FsSD2_9tk-+a4icjt9PsDg@mail.gmail.com>
2023-06-03 12:50   ` [dm-devel] [PATCH] Improve the dm-integrity documentation Bagas Sanjaya

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230603201525.9409-4-eatnumber1@gmail.com \
    --to=eatnumber1@gmail.com \
    --cc=bagasdotme@gmail.com \
    --cc=dm-devel@redhat.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=mpatocka@redhat.com \
    --cc=snitzer@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).