Skip to content

Commit 52145f2

Browse files
eatnumber1Mike Snitzer
authored andcommitted
Documentation: dm-integrity: Document default values.
Signed-off-by: Russell Harmon <[email protected]> Signed-off-by: Mike Snitzer <[email protected]>
1 parent 3b67145 commit 52145f2

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

Documentation/admin-guide/device-mapper/dm-integrity.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ journal_sectors:number
102102
device. If the device is already formatted, the value from the
103103
superblock is used.
104104

105-
interleave_sectors:number
105+
interleave_sectors:number (default 32768)
106106
The number of interleaved sectors. This values is rounded down to
107107
a power of two. If the device is already formatted, the value from
108108
the superblock is used.
@@ -111,16 +111,16 @@ meta_device:device
111111
Don't interleave the data and metadata on the device. Use a
112112
separate device for metadata.
113113

114-
buffer_sectors:number
115-
The number of sectors in one buffer. The value is rounded down to
116-
a power of two.
114+
buffer_sectors:number (default 128)
115+
The number of sectors in one metadata buffer. The value is rounded
116+
down to a power of two.
117117

118-
journal_watermark:number
118+
journal_watermark:number (default 50)
119119
The journal watermark in percents. When the size of the journal
120120
exceeds this watermark, the thread that flushes the journal will
121121
be started.
122122

123-
commit_time:number
123+
commit_time:number (default 10000)
124124
Commit time in milliseconds. When this time passes, the journal is
125125
written. The journal is also written immediately if the FLUSH
126126
request is received.
@@ -168,11 +168,10 @@ journal_mac:algorithm(:key) (the key is optional)
168168
the journal. Thus, modified sector number would be detected at
169169
this stage.
170170

171-
block_size:number
172-
The size of a data block in bytes. The larger the block size the
171+
block_size:number (default 512)
172+
The size of a data block in bytes. The larger the block size the
173173
less overhead there is for per-block integrity metadata.
174-
Supported values are 512, 1024, 2048 and 4096 bytes. If not
175-
specified the default block size is 512 bytes.
174+
Supported values are 512, 1024, 2048 and 4096 bytes.
176175

177176
sectors_per_bit:number
178177
In the bitmap mode, this parameter specifies the number of
@@ -291,7 +290,8 @@ The layout of the formatted block device:
291290
Each run contains:
292291

293292
* tag area - it contains integrity tags. There is one tag for each
294-
sector in the data area
293+
sector in the data area. The size of this area is always 4KiB or
294+
greater.
295295
* data area - it contains data sectors. The number of data sectors
296296
in one run must be a power of two. log2 of this value is stored
297297
in the superblock.

0 commit comments

Comments
 (0)