Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added clarity and doc of snapshot -i option #116

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions Documentation/btrfs-subvolume.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,11 @@ do not affect the files in the original subvolume.

SUBCOMMAND
-----------
*create* [-i <qgroupid>] [<dest>/]<name>::
Create a subvolume <name> in <dest>.
*create* [-i <qgroupid>] [<subdir>/]<name>::
Create a new subvolume called <name> in <subdir>. Once created the new subvolume
will look like a subdirectory but will actually be a subvolume.
+
If <dest> is not given, subvolume <name> will be created in the current
If <subdir> is not given, the new subvolume will be created in the current
directory.
+
`Options`
Expand Down Expand Up @@ -157,17 +158,21 @@ The id can be obtained from *btrfs subvolume list*, *btrfs subvolume show* or
*show* <path>::
Show information of a given subvolume in the <path>.

*snapshot* [-r] <source> <dest>|[<dest>/]<name>::
Create a snapshot of the subvolume <source> with the
name <name> in the <dest> directory.
*snapshot* [-r] [-i <qgroupid>] <subvolume> { <subdir>/<name> | <subdir> }::
Create a snapshot of a <subvolume>. Call it <name> and place it in the <subdir>.
+
When only <subdir> is given, the subvolume will be named using the basename of <subvolume>.
+
(<subvolume> looks like a sub-directory, but is actually a btrfs subvolume rather than a subdirectory.)
+
If only <dest> is given, the subvolume will be named the basename of <source>.
If <source> is not a subvolume, btrfs returns an error.
+
`Options`
+
-r::::
Make the new snapshot read only.
-i <qgroupid>::::
Add the new snapshot to a qgroup (quota group). This option can be given multiple times.

*sync* <path> [subvolid...]::
Wait until given subvolume(s) are completely removed from the filesystem after
Expand Down