Archive-Team
/
zfs
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 103 Wiki Activity

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.

Signed-off-by: Shawn Bayern <sbayern@law.fsu.edu>

Added newlines for sentences and formatting for -r flag

I've made the formatting changes suggested by Brian Behlendorf
to pass the checkstyle tests and add formatting for an inline
flag.

Signed-off-by: Shawn Bayern <sbayern@law.fsu.edu>

Removed trailing whitespace to satisfy automated checks

I removed a whitespace at the end of line 55 to satisfy the
process that verifies the style of man pages.

Signed-off-by: Shawn Bayern <sbayern@law.fsu.edu>
This commit is contained in:
Shawn Bayern 2024-02-06 14:27:55 -05:00
parent 6dccdf501e
commit b156f62fc4
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
man/man8/zfs-snapshot.8
View File

@ -44,13 +44,21 @@
.Ar dataset Ns @ Ns Ar snapname Ns …
.
.Sh DESCRIPTION
All previous modifications by successful system calls to the file system are
part of the snapshots.
Snapshots are taken atomically, so that all snapshots correspond to the same
moment in time.
Creates a snapshot of a dataset or multiple snapshots of different
datasets.
.Pp
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
can be used as an alias for
.Nm zfs Cm snapshot .
.Pp
See the
.Sx Snapshots
section of