Update zfs-snapshot.8
Fixes a small inaccuracy in the description of snapshot atomicity zfs-snapshot(8) appears to contain a small error. The existing version reads "Snapshots are taken atomically, so that all snapshots correspond to the same moment in time." Per zfs_main.c, which in do_snapshot() simply loops over argv, this does not appear to be correct when multiple snapshots are specified explicitly on the command line. I believe the intent of the man page was to say that *recursive* snapshots are all created atomically. This proposed change fixes that error. Because the existing statement may confuse some readers anyway, the commit also also adds a small amount of general explanatory information that may be helpful. The change also adds an introductory sentence that summarizes what 'zfs snapshot' does in the first place. In that sentence, the text "different datasets" is intended to indicate that (again per the code) the same dataset cannot be specified multiple times on the command line. Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov> Signed-off-by: Shawn Bayern <sbayern@law.fsu.edu> Closes #15857
This commit is contained in:
parent
a5a725440b
commit
d0d2733204
|
@ -44,13 +44,21 @@
|
||||||
.Ar dataset Ns @ Ns Ar snapname Ns …
|
.Ar dataset Ns @ Ns Ar snapname Ns …
|
||||||
.
|
.
|
||||||
.Sh DESCRIPTION
|
.Sh DESCRIPTION
|
||||||
All previous modifications by successful system calls to the file system are
|
Creates a snapshot of a dataset or multiple snapshots of different
|
||||||
part of the snapshots.
|
datasets.
|
||||||
Snapshots are taken atomically, so that all snapshots correspond to the same
|
.Pp
|
||||||
moment in time.
|
Snapshots are created atomically.
|
||||||
|
That is, a snapshot is a consistent image of a dataset at a specific
|
||||||
|
point in time; it includes all modifications to the dataset made by
|
||||||
|
system calls that have successfully completed before that point in time.
|
||||||
|
Recursive snapshots created through the
|
||||||
|
.Fl r
|
||||||
|
option are all created at the same time.
|
||||||
|
.Pp
|
||||||
.Nm zfs Cm snap
|
.Nm zfs Cm snap
|
||||||
can be used as an alias for
|
can be used as an alias for
|
||||||
.Nm zfs Cm snapshot .
|
.Nm zfs Cm snapshot .
|
||||||
|
.Pp
|
||||||
See the
|
See the
|
||||||
.Sx Snapshots
|
.Sx Snapshots
|
||||||
section of
|
section of
|
||||||
|
|
Loading…
Reference in New Issue