RepoMirrors/btrfs-progs
1
0
Fork 0
mirror of https://github.com/kdave/btrfs-progs synced 2025-03-31 07:36:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

btrfs-progs: doc: update manual page of btrfs subvolume

Browse Source 
Some information is obsolete and updated as follows:

 - add missing explanations of some options
 - remove outdated explanation of "subvolrootid" mount option
 - reorder/group options of "subvolume list" so it matches the  help
   message
 - add explanation of different meanings of parent in "parent ID/UUID"
 - fix indentation/spelling
 - add missing comma

Signed-off-by: Misono Tomohiro <misono.tomohiro@jp.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.com>
This commit is contained in:
Misono Tomohiro 2018-06-18 17:40:49 +09:00 committed by David Sterba
parent e578b59bf6
commit 47abaaf6d0
1 changed files with 55 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
Documentation/btrfs-subvolume.asciidoc
View File

@ -77,13 +77,16 @@ safely stored on the device.
`Options`
+
-c|--commit-after::::
wait for transaction commit at the end of the operation
wait for transaction commit at the end of the operation.
+
-C|--commit-each::::
wait for transaction commit after deleting each subvolume
wait for transaction commit after deleting each subvolume.
+
-v|--verbose::::
verbose output of operations.
*find-new* <subvolume> <last_gen>::
List the recently modified files in a subvolume, after <last_gen> ID.
List the recently modified files in a subvolume, after <last_gen> generation.
*get-default* <path>::
Get the default subvolume of the filesystem <path>.
@ -93,40 +96,54 @@ The output format is similar to *subvolume list* command.
*list* [options] [-G [\+|-]<value>] [-C [+|-]<value>] [--sort=rootid,gen,ogen,path] <path>::
List the subvolumes present in the filesystem <path>.
+
For every subvolume the following information is shown by default. +
ID <ID> top level <ID> path <path> +
where path is the relative path of the subvolume to the top level subvolume.
For every subvolume the following information is shown by default:
+
ID <ID> gen <generation> top level <ID> path <path>
+
where ID is subvolume's id, gen is an internal counter which is updated
every transaction, top level is the same as parent subvolume's id, and
path is the relative path of the subvolume to the top level subvolume.
The subvolume's ID may be used by the subvolume set-default command,
or at mount time via the subvolid= option.
If `-p` is given, then parent <ID> is added to the output between ID
and top level. The parent's ID may be used at mount time via the
`subvolrootid=` option.
+
`Options`
+
-p::::
print parent ID.
Path filtering;;
-o::::
print only subvolumes below specified <path>.
-a::::
print all the subvolumes in the filesystem and distinguish between
absolute and relative path with respect to the given <path>.
Field selection;;
-p::::
print the parent ID
('parent' here means the subvolume which contains this subvolume).
-c::::
print the ogeneration of the subvolume, aliases: ogen or origin generation.
-g::::
print the generation of the subvolume.
-o::::
print only subvolumes below specified <path>.
print the generation of the subvolume (default).
-u::::
print the UUID of the subvolume.
-q::::
print the parent uuid of subvolumes (and snapshots).
print the parent UUID of the subvolume
('parent' here means subvolume of which this subvolume is a snapshot).
-R::::
print the UUID of the sent subvolume, where the subvolume is the result of a receive operation
-t::::
print the result as a table.
print the UUID of the sent subvolume, where the subvolume is the result of a receive operation.
Type filtering;;
-s::::
only snapshot subvolumes in the filesystem will be listed.
-r::::
only readonly subvolumes in the filesystem will be listed.
-d::::
list deleted subvolumes that are not yet cleaned.
Other;;
-t::::
print the result as a table.
Sorting;;
-G [+|-]<value>::::
list subvolumes in the filesystem that its generation is
>=, \<= or = value. \'\+' means >= value, \'-' means \<= value, If there is
@ -144,9 +161,9 @@ for --sort you can combine some items together by \',', just like
*set-default* [<subvolume>|<id> <path>]::
Set the default subvolume for the (mounted) filesystem.
+
Set the default subvolume for the (mounted) filesystem at <path>. This will hide
the top-level subvolume (ie. the one mounted with 'subvol=/' or 'subvolid=5').
the top-level subvolume (i.e. the one mounted with 'subvol=/' or 'subvolid=5').
Takes action on next mount.
+
There are two ways how to specify the subvolume, by <id> or by the <subvolume>
@ -154,10 +171,22 @@ path.
The id can be obtained from *btrfs subvolume list*, *btrfs subvolume show* or
*btrfs inspect-internal rootid*.
*show* <path>::
*show* [options] <path>|<mnt>::
Show information of a given subvolume in the <path>.
+
`Options`
+
-r|--rootid::::
rootid of the subvolume.
-u|--uuid:::
UUID of the subvolume.
*snapshot* [-r] <source> <dest>|[<dest>/]<name>::
+
If no option is specified, subvolume information of <path> is shown,
otherwise the subvolume information of rootid or UUID in the filesystem
is shown.
*snapshot* [-r|-i <qgroupid>] <source> <dest>|[<dest>/]<name>::
Create a snapshot of the subvolume <source> with the
name <name> in the <dest> directory.
+
@ -168,6 +197,10 @@ If <source> is not a subvolume, btrfs returns an error.
+
-r::::
Make the new snapshot read only.
+
-i <qgroupid>::::
Add the newly created subvolume to a qgroup. This option can be given multiple
times.
*sync* <path> [subvolid...]::
Wait until given subvolume(s) are completely removed from the filesystem after