mirror of
https://github.com/kdave/btrfs-progs
synced 2025-02-17 18:26:55 +00:00
btrfs-progs: docs: fix many typos, plus three edits for clarity
Signed-off-by: Nicholas D Steeves <nsteeves@gmail.com> Signed-off-by: David Sterba <dsterba@suse.com>
This commit is contained in:
parent
621d07bd3a
commit
17144afb40
@ -89,7 +89,7 @@ warned and has a few seconds to cancel the operation before it starts. The
|
|||||||
warning and delay can be skipped with '--full-balance' option.
|
warning and delay can be skipped with '--full-balance' option.
|
||||||
+
|
+
|
||||||
Please note that the filters must be written together with the '-d', '-m' and
|
Please note that the filters must be written together with the '-d', '-m' and
|
||||||
'-s' options, because they're optional and bare '-d' etc alwo work and mean no
|
'-s' options, because they're optional and bare '-d' etc also work and mean no
|
||||||
filters.
|
filters.
|
||||||
+
|
+
|
||||||
`Options`
|
`Options`
|
||||||
|
@ -30,11 +30,11 @@ data structures satisfy the constraints, point to the right objects or are
|
|||||||
correctly connected together.
|
correctly connected together.
|
||||||
|
|
||||||
There are several cross checks that can detect wrong reference counts of shared
|
There are several cross checks that can detect wrong reference counts of shared
|
||||||
extents, backrefrences, missing extents of inodes, directory and inode
|
extents, backreferences, missing extents of inodes, directory and inode
|
||||||
connectivity etc.
|
connectivity etc.
|
||||||
|
|
||||||
The amount of memory required can be high, depending on the size of the
|
The amount of memory required can be high, depending on the size of the
|
||||||
filesystem, smililarly the run time.
|
filesystem, similarly the run time.
|
||||||
|
|
||||||
SAFE OR ADVISORY OPTIONS
|
SAFE OR ADVISORY OPTIONS
|
||||||
------------------------
|
------------------------
|
||||||
@ -49,7 +49,7 @@ verify checksums of data blocks
|
|||||||
+
|
+
|
||||||
This expects that the filesystem is otherwise
|
This expects that the filesystem is otherwise
|
||||||
OK, so this is basically and offline 'scrub' but does not repair data from
|
OK, so this is basically and offline 'scrub' but does not repair data from
|
||||||
spare coipes.
|
spare copies.
|
||||||
|
|
||||||
--chunk-root <bytenr>::
|
--chunk-root <bytenr>::
|
||||||
use the given offset 'bytenr' for the chunk tree root
|
use the given offset 'bytenr' for the chunk tree root
|
||||||
@ -111,7 +111,7 @@ NOTE: Do not use unless you know what you're doing.
|
|||||||
select mode of operation regarding memory and IO
|
select mode of operation regarding memory and IO
|
||||||
+
|
+
|
||||||
The 'MODE' can be one of 'original' and 'lowmem'. The original mode is mostly
|
The 'MODE' can be one of 'original' and 'lowmem'. The original mode is mostly
|
||||||
unoptimized regarding memory consumpption and can lead to out-of-memory
|
unoptimized regarding memory consumption and can lead to out-of-memory
|
||||||
conditions on large filesystems. The possible workaround is to export the block
|
conditions on large filesystems. The possible workaround is to export the block
|
||||||
device over network to a machine with enough memory. The low memory mode is
|
device over network to a machine with enough memory. The low memory mode is
|
||||||
supposed to address the memory consumption, at the cost of increased IO when it
|
supposed to address the memory consumption, at the cost of increased IO when it
|
||||||
|
@ -24,14 +24,14 @@ similarity, the RAID terminology is widely used in the documentation. See
|
|||||||
constraints.
|
constraints.
|
||||||
|
|
||||||
The device management works on a mounted filesystem. Devices can be added,
|
The device management works on a mounted filesystem. Devices can be added,
|
||||||
removed or replaced, by commands profided by *btrfs device* and *btrfs replace*.
|
removed or replaced, by commands provided by *btrfs device* and *btrfs replace*.
|
||||||
|
|
||||||
The profiles can be also changed, provided there's enough workspace to do the
|
The profiles can be also changed, provided there's enough workspace to do the
|
||||||
conversion, using the *btrfs balance* command and namely the filter 'convert'.
|
conversion, using the *btrfs balance* command and namely the filter 'convert'.
|
||||||
|
|
||||||
Profile::
|
Profile::
|
||||||
A profile describes an allocation policy based on the redundancy/replication
|
A profile describes an allocation policy based on the redundancy/replication
|
||||||
constrants in connection with the number of devices. The profile applies to
|
constraints in connection with the number of devices. The profile applies to
|
||||||
data and metadata block groups separately.
|
data and metadata block groups separately.
|
||||||
|
|
||||||
RAID level::
|
RAID level::
|
||||||
@ -182,7 +182,7 @@ blocks, the disk seeking is the key factor affecting performance.
|
|||||||
|
|
||||||
You'll note that the system block group has been also converted to RAID1, this
|
You'll note that the system block group has been also converted to RAID1, this
|
||||||
normally happens as the system block group also holds metadata (the physical to
|
normally happens as the system block group also holds metadata (the physical to
|
||||||
logial mappings).
|
logical mappings).
|
||||||
|
|
||||||
What changed:
|
What changed:
|
||||||
|
|
||||||
|
@ -14,7 +14,7 @@ DESCRIPTION
|
|||||||
*btrfs filesystem* is used to perform several whole filesystem level tasks,
|
*btrfs filesystem* is used to perform several whole filesystem level tasks,
|
||||||
including all the regular filesystem operations like resizing, space stats,
|
including all the regular filesystem operations like resizing, space stats,
|
||||||
label setting/getting, and defragmentation. There are other whole filesystem
|
label setting/getting, and defragmentation. There are other whole filesystem
|
||||||
taks like scrub or balance that are grouped in separate commands.
|
tasks like scrub or balance that are grouped in separate commands.
|
||||||
|
|
||||||
SUBCOMMAND
|
SUBCOMMAND
|
||||||
----------
|
----------
|
||||||
@ -120,7 +120,7 @@ defragment files recursively in given directories
|
|||||||
flush data for each file before going to the next file.
|
flush data for each file before going to the next file.
|
||||||
+
|
+
|
||||||
This will limit the amount of dirty data to current file, otherwise the amount
|
This will limit the amount of dirty data to current file, otherwise the amount
|
||||||
cumulates from several files and will increase system load. This can also lead
|
accumulates from several files and will increase system load. This can also lead
|
||||||
to ENOSPC if there's too much dirty data to write and it's not possible to make
|
to ENOSPC if there's too much dirty data to write and it's not possible to make
|
||||||
the reservations for the new data (ie. how the COW design works).
|
the reservations for the new data (ie. how the COW design works).
|
||||||
+
|
+
|
||||||
@ -196,7 +196,7 @@ If the prefix '+' or '-' is present the size is increased or decreased
|
|||||||
by the quantity 'size'.
|
by the quantity 'size'.
|
||||||
If no units are specified, bytes are assumed for 'size'.
|
If no units are specified, bytes are assumed for 'size'.
|
||||||
Optionally, the size parameter may be suffixed by one of the following
|
Optionally, the size parameter may be suffixed by one of the following
|
||||||
units designators: \'K', \'M', \'G', \'T', \'P', or \'E', which represent
|
unit designators: \'K', \'M', \'G', \'T', \'P', or \'E', which represent
|
||||||
KiB, MiB, GiB, TiB, PiB, or EiB, respectively (case does not matter).
|
KiB, MiB, GiB, TiB, PiB, or EiB, respectively (case does not matter).
|
||||||
+
|
+
|
||||||
If 'max' is passed, the filesystem will occupy all available space on the
|
If 'max' is passed, the filesystem will occupy all available space on the
|
||||||
|
@ -26,7 +26,7 @@ Show btrfs superblock information stored on given devices in textual form.
|
|||||||
By default the first superblock is printed, more details about all copies or
|
By default the first superblock is printed, more details about all copies or
|
||||||
additional backup data can be printed.
|
additional backup data can be printed.
|
||||||
+
|
+
|
||||||
Besides verifictaion of the filesystem signature, there are no other sanity
|
Besides verification of the filesystem signature, there are no other sanity
|
||||||
checks. The superblock checksum status is reported, the device item and
|
checks. The superblock checksum status is reported, the device item and
|
||||||
filesystem UUIDs are checked and reported.
|
filesystem UUIDs are checked and reported.
|
||||||
+
|
+
|
||||||
@ -51,8 +51,8 @@ for debugging (disables the '-f' option)
|
|||||||
If there are multiple options specified, only the last one applies.
|
If there are multiple options specified, only the last one applies.
|
||||||
+
|
+
|
||||||
-F|--force::::
|
-F|--force::::
|
||||||
attempt to print the superblock even if thre's no valid BTRFS signature found,
|
attempt to print the superblock even if a valid BTRFS signature is not found;
|
||||||
the result may be completely wrong if the data do not resemble a superblock
|
the result may be completely wrong if the data does not resemble a superblock
|
||||||
+
|
+
|
||||||
-s|--super <bytenr>::::
|
-s|--super <bytenr>::::
|
||||||
(see compatibility note above)
|
(see compatibility note above)
|
||||||
|
@ -314,9 +314,10 @@ normally be needed.
|
|||||||
*skip_balance*::
|
*skip_balance*::
|
||||||
(since: 3.3, default: off)
|
(since: 3.3, default: off)
|
||||||
+
|
+
|
||||||
Skip automatic resume of interrupted balance operation after mount.
|
Skip automatic resume of an interrupted balance operation. The operation can
|
||||||
May be resumed with *btrfs balance resume* or the paused state can be removed
|
later be resumed with *btrfs balance resume*, or the paused state can be
|
||||||
by *btrfs balance cancel*. The default behaviour is to start interrutpd balance.
|
removed with *btrfs balance cancel*. The default behaviour is to resume an
|
||||||
|
interrupted balance immediately after a volume is mounted.
|
||||||
|
|
||||||
*space_cache*::
|
*space_cache*::
|
||||||
*space_cache='version'*::
|
*space_cache='version'*::
|
||||||
@ -440,9 +441,9 @@ dump-super device* will dump a superblock, you can map the value of
|
|||||||
|
|
||||||
after mkfs, on a mounted filesystem::
|
after mkfs, on a mounted filesystem::
|
||||||
The features of a filesystem (with a given UUID) are listed in
|
The features of a filesystem (with a given UUID) are listed in
|
||||||
`/sys/fs/btrfs/UUID/features/`, one file per feature. The status of is stored
|
`/sys/fs/btrfs/UUID/features/`, one file per feature. The status is stored
|
||||||
insid the file. The value '1' is for enabled, '0' means the feature had
|
inside the file. The value '1' is for enabled and active, while '0' means the
|
||||||
been enabled at the mount time and turned off afterwards.
|
feature was enabled at mount time but turned off afterwards.
|
||||||
+
|
+
|
||||||
Whether a particular feature can be turned on a mounted filesystem can be found
|
Whether a particular feature can be turned on a mounted filesystem can be found
|
||||||
in the directory `/sys/fs/btrfs/features/`, one file per feature. The value '1'
|
in the directory `/sys/fs/btrfs/features/`, one file per feature. The value '1'
|
||||||
@ -567,7 +568,7 @@ crw------- 1 root root 10, 234 Jan 1 12:00 /dev/btrfs-control
|
|||||||
--------------------
|
--------------------
|
||||||
|
|
||||||
The device accepts some ioctl calls that can perform following actions on the
|
The device accepts some ioctl calls that can perform following actions on the
|
||||||
filesyste module:
|
filesystem module:
|
||||||
|
|
||||||
* scan devices for btrfs filesystem (ie. to let multi-device filesystems mount
|
* scan devices for btrfs filesystem (ie. to let multi-device filesystems mount
|
||||||
automatically) and register them with the kernel module
|
automatically) and register them with the kernel module
|
||||||
|
@ -84,7 +84,7 @@ from within this qgroup.
|
|||||||
SUBVOLUME QUOTA GROUPS
|
SUBVOLUME QUOTA GROUPS
|
||||||
~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
The basic notion of the Subvolume Quota feature is the qouta group, short
|
The basic notion of the Subvolume Quota feature is the quota group, short
|
||||||
qgroup. Qgroups are notated as 'level/id', eg. the qgroup 3/2 is a qgroup of
|
qgroup. Qgroups are notated as 'level/id', eg. the qgroup 3/2 is a qgroup of
|
||||||
level 3. For level 0, the leading '0/' can be omitted.
|
level 3. For level 0, the leading '0/' can be omitted.
|
||||||
Qgroups of level 0 get created automatically when a subvolume/snapshot gets
|
Qgroups of level 0 get created automatically when a subvolume/snapshot gets
|
||||||
@ -182,7 +182,7 @@ when the subvolume is deleted.
|
|||||||
|
|
||||||
When you have several users on a machine, with home directories probably under
|
When you have several users on a machine, with home directories probably under
|
||||||
/home, you might want to restrict /home as a whole, while restricting every
|
/home, you might want to restrict /home as a whole, while restricting every
|
||||||
user to an indiviual limit as well. This is easily accomplished by creating a
|
user to an individual limit as well. This is easily accomplished by creating a
|
||||||
qgroup for /home , eg. 1/1, and assigning all user subvolumes to it.
|
qgroup for /home , eg. 1/1, and assigning all user subvolumes to it.
|
||||||
Restricting this qgroup will limit /home, while every user subvolume can get
|
Restricting this qgroup will limit /home, while every user subvolume can get
|
||||||
its own (lower) limit.
|
its own (lower) limit.
|
||||||
|
@ -31,7 +31,7 @@ the stream, and print the stream metadata, one operation per line.
|
|||||||
|
|
||||||
3. default subvolume has changed or you didn't mount the filesystem at the toplevel subvolume
|
3. default subvolume has changed or you didn't mount the filesystem at the toplevel subvolume
|
||||||
|
|
||||||
A subvolume is made read-only after the receiving process finishes succesfully (see BUGS below).
|
A subvolume is made read-only after the receiving process finishes successfully (see BUGS below).
|
||||||
|
|
||||||
`Options`
|
`Options`
|
||||||
|
|
||||||
@ -66,7 +66,7 @@ tell us where this filesystem is mounted.
|
|||||||
--dump::
|
--dump::
|
||||||
dump the stream metadata, one line per operation
|
dump the stream metadata, one line per operation
|
||||||
+
|
+
|
||||||
Does not require the 'path' parameter. The filesystem chanded.
|
Does not require the 'path' parameter. The filesystem remains unchanged.
|
||||||
|
|
||||||
BUGS
|
BUGS
|
||||||
----
|
----
|
||||||
|
@ -36,7 +36,7 @@ https://btrfs.wiki.kernel.org/index.php/Restore
|
|||||||
OPTIONS
|
OPTIONS
|
||||||
-------
|
-------
|
||||||
-s|--snapshots::
|
-s|--snapshots::
|
||||||
get also snapshots that are skippped by default
|
get also snapshots that are skipped by default
|
||||||
|
|
||||||
-x|--xattr::
|
-x|--xattr::
|
||||||
get extended attributes
|
get extended attributes
|
||||||
|
@ -25,11 +25,10 @@ default 'idle' so background scrub should not interfere with normal filesystem
|
|||||||
operation significantly.
|
operation significantly.
|
||||||
|
|
||||||
The scrubbing status is recorded in '/var/lib/btrfs/' in textual files named
|
The scrubbing status is recorded in '/var/lib/btrfs/' in textual files named
|
||||||
'scrub.status.UUID' for a filesystem identified by the given UUID. (An
|
'scrub.status.UUID' for a filesystem identified by the given UUID. (Progress
|
||||||
itermediate progress is communicated through a named pipe in file
|
state is communicated through a named pipe in file 'scrub.progress.UUID' in the
|
||||||
'scrub.progress.UUID' in the same directory.) The status file is updated
|
same directory.) The status file is updated every 5 seconds. A resumed scrub
|
||||||
periodically every 5 seconds. A resumed scrub will continue from the last
|
will continue from the last saved position.
|
||||||
saved position.
|
|
||||||
|
|
||||||
SUBCOMMAND
|
SUBCOMMAND
|
||||||
----------
|
----------
|
||||||
|
@ -45,8 +45,8 @@ send an incremental stream from 'parent' to 'subvol'
|
|||||||
-c <clone-src>::
|
-c <clone-src>::
|
||||||
use this snapshot as a clone source for an incremental send (multiple allowed)
|
use this snapshot as a clone source for an incremental send (multiple allowed)
|
||||||
-f <outfile>::
|
-f <outfile>::
|
||||||
output is normally written to standard outout so it can be eg. piped to
|
output is normally written to standard output so it can be, for example, piped
|
||||||
receive, use this option to write it to a file
|
to btrfs receive. Use this option to write it to a file instead.
|
||||||
--no-data::
|
--no-data::
|
||||||
send in 'NO_FILE_DATA' mode
|
send in 'NO_FILE_DATA' mode
|
||||||
+
|
+
|
||||||
@ -58,7 +58,7 @@ useful to show the differences in metadata.
|
|||||||
enable verbose output, print generated commands in a readable form, (each
|
enable verbose output, print generated commands in a readable form, (each
|
||||||
occurrence of this option increases the verbosity level)
|
occurrence of this option increases the verbosity level)
|
||||||
-q|--quiet::
|
-q|--quiet::
|
||||||
suppress all messagese except errors
|
suppress all messages except errors
|
||||||
|
|
||||||
EXIT STATUS
|
EXIT STATUS
|
||||||
-----------
|
-----------
|
||||||
|
Loading…
Reference in New Issue
Block a user