[Bug 276850] zfs-snapshot(8) contains a small error about atomicity when multiple snapshots are created

From: <bugzilla-noreply_at_freebsd.org>
Date: Tue, 06 Feb 2024 05:17:17 UTC
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=276850

            Bug ID: 276850
           Summary: zfs-snapshot(8) contains a small error about atomicity
                    when multiple snapshots are created
           Product: Documentation
           Version: Latest
          Hardware: Any
                OS: Any
            Status: New
          Severity: Affects Some People
          Priority: ---
         Component: Manual Pages
          Assignee: bugs@FreeBSD.org
          Reporter: sbayern@law.fsu.edu
                CC: doc@FreeBSD.org

Created attachment 248213
  --> https://bugs.freebsd.org/bugzilla/attachment.cgi?id=248213&action=edit
diff for zfs-snapshot(8) man page

zfs-snapshot(8) appears to contain a small error.  It 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.

I've submitted a diff for the man page that fixes this error and also adds a
small amount of general explanatory information that may be helpful to some
readers.  The existing statement may confuse some readers anyway, so I've tried
to elaborate slightly.

(The diff also includes a small amount of insignificant copy editing; for
example, "moment in time" is redundant, so I've simply used "moment" instead.)

-- 
You are receiving this mail because:
You are on the CC list for the bug.