[Bug 266358] FFS/UFS snapshots: improve documentation for removal (deletion) and unlinking

https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=266358

Graham Perrin <grahamperrin@freebsd.org> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|Closed                      |Open
         Resolution|FIXED                       |---

--- Comment #19 from Graham Perrin <grahamperrin@freebsd.org> ---
mksnap_ffs(8) in 13.2-RC4 has a three-paragraph description, and the second
example is 'Delete a snapshot:'.

mksnap_ffs(8) in CURRENT built a few hours ago has a two-paragraph description,
and only one example: 

----

root@mowa219-gjp4-8570p-freebsd:~ # man -P more mksnap_ffs
MKSNAP_FFS(8)           FreeBSD System Manager's Manual          MKSNAP_FFS(8)

NAME
     mksnap_ffs – take a file system snapshot

SYNOPSIS
     mksnap_ffs snapshot_name

DESCRIPTION
     The mksnap_ffs utility creates a snapshot named snapshot_name.

     The group ownership of the file is set to “operator”; the owner of the
     file remains “root”.  The mode of the snapshot is set to be readable by
     the owner or members of the “operator” group.

EXAMPLES
     Create a snapshot of /usr/home file system and mount the snapshot
     elsewhere:

           mksnap_ffs /usr/home/snapshot
           mdconfig -a -t vnode -o readonly -f /usr/home/snapshot
           mount -o ro /dev/md0 /mnt/

SEE ALSO
     chmod(2), chown(8), mdconfig(8), mount(8)

HISTORY
     The mksnap_ffs utility first appeared in FreeBSD 5.1.

CAVEATS
     The disk full situation is not handled gracefully and may lead to a
     system panic when no free blocks are found.

     Every filesystem can have only up to 20 active snapshots.  When this
     limit is reached, attempting to create more snapshots fails with ENOSPC,
     and mksnap_ffs reports that it is “out of space”.

FreeBSD 14.0-CURRENT            October 3, 2016           FreeBSD 14.0-CURRENT
root@mowa219-gjp4-8570p-freebsd:~ # uname -aKU
FreeBSD mowa219-gjp4-8570p-freebsd 14.0-CURRENT FreeBSD 14.0-CURRENT #36
main-n261767-508aee968143: Sat Mar 25 23:33:05 GMT 2023    
grahamperrin@mowa219-gjp4-8570p-freebsd:/usr/obj/usr/src/amd64.amd64/sys/GENERIC-NODEBUG
amd64 1400084 1400084
root@mowa219-gjp4-8570p-freebsd:~ #

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