Skip to content

Commit ecf62d9

Browse files
committed
btrfs-progs: docs: various fixups and updates
[ci skip] Signed-off-by: David Sterba <dsterba@suse.com>
1 parent 6f30752 commit ecf62d9

File tree

2 files changed

+13
-5
lines changed

2 files changed

+13
-5
lines changed

Documentation/btrfs-filesystem.rst

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ DESCRIPTION
1212
:command:`btrfs filesystem` is used to perform several whole filesystem level tasks,
1313
including all the regular filesystem operations like resizing, space stats,
1414
label setting/getting, and defragmentation. There are other whole filesystem
15-
tasks like scrub or balance that are grouped in separate commands.
15+
tasks like scrub or balance that are grouped in separate commands (:doc:`btrfs-scrub`, :doc:`btrfs-balance`).
1616

1717
SUBCOMMAND
1818
----------
@@ -83,7 +83,7 @@ df [options] <path>
8383
defragment [options] <file>|<dir> [<file>|<dir>...]
8484
Defragment file data on a mounted filesystem. Requires kernel 2.6.33 and newer.
8585

86-
If *-r* is passed, files in dir will be defragmented recursively (not
86+
If *-r* is passed, files in *dir* will be defragmented recursively (not
8787
descending to subvolumes, mount points and directory symlinks).
8888
The start position and the number of bytes to defragment can be specified by
8989
start and length using *-s* and *-l* options below.
@@ -117,6 +117,13 @@ defragment [options] <file>|<dir> [<file>|<dir>...]
117117
algorithm, *zlib* (default), *lzo* or *zstd*. Currently it's not possible to select no
118118
compression. See also section *EXAMPLES*.
119119

120+
-L|--level <level>
121+
Since kernel 6.14 the compresison can also take the level parameter which will be used
122+
only for the defragmentation and overrides the eventual mount option compression level.
123+
Valid levels depend on the compression algorithms: *zlib*
124+
1..9, *lzo* does not have any levels, *zstd* the standard levels 1..15 and also the
125+
realtime -1..-15.
126+
120127
-r
121128
defragment files recursively in given directories, does not descend to
122129
subvolumes or mount points
@@ -143,6 +150,7 @@ defragment [options] <file>|<dir> [<file>|<dir>...]
143150
Perform defragmentation in the range in SIZE steps and flush (*-f*) after each one.
144151
The range is default (the whole file) or given by *-s* and *-l*, split into
145152
the steps or done in one go if the step is larger. Minimum range size is 256KiB.
153+
With verbosity options the progress of defragmentation will be also printed.
146154

147155
-v
148156
(deprecated) alias for global *-v* option

Documentation/btrfs-inspect-internal.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ logical-resolve [-Pvo] [-s <bufsize>] <logical> <path>
164164
to be obtained by other means.
165165
-s <bufsize>
166166
set internal buffer for storing the file names to *bufsize*, default is 64KiB,
167-
maximum 16MiB. Buffer sizes over 64Kib require kernel support for the V2 ioctl
167+
maximum 16MiB. Buffer sizes over 64KiB require kernel support for the V2 ioctl
168168
(added in 4.15).
169169
-v
170170
(deprecated) alias for global *-v* option
@@ -225,7 +225,7 @@ list-chunks [options] <path>
225225
--sort MODE
226226
sort by a column (ascending):
227227

228-
MODE is a coma separated list of:
228+
MODE is a comma separated list of:
229229

230230
*devid* - by device id (default, with pstart)
231231

@@ -272,7 +272,7 @@ map-swapfile [options] <file>
272272
``Options``
273273

274274
-r|--resume-offset
275-
print only the value suitable as resume offset for file */sys/power/resume_offset*
275+
print only the value suitable as resume offset for file :file:`/sys/power/resume_offset`
276276

277277
min-dev-size [options] <path>
278278
(needs root privileges)

0 commit comments

Comments
 (0)