FFS/UFS snapshots: improve documentation for removal (deletion) and unlinking

[darius-dons.net.au]

Summary

Add links to useful man pages and provide a more detailed description of FFS/UFS snapshots.

[rpokala]

sbin/mksnap_ffs/mksnap_ffs.8

51

"system. Typically,"

52

"system, but"

52

New sentences should start on new lines, so move "Snapshots can" to the start of the next line.

57

After a snapshot is taken, it appears as a file.
The file is the size of the filesystem from which it was taken.
It can be moved, renamed, or deleted (which removes the snapshot).

[mhorne]

sbin/mksnap_ffs/mksnap_ffs.8

52

You can use the .Pa (file path) macro for .snap.

I would also suggest being explicit here and saying: "the .snap directory in the root..."

70

Man pages don't get blank lines. mandoc -Tlint will warn you about this.

80

Same here, probably you want .Pp.

[mckusick]

These changes look good to me. Only change is to eliminate the blank lines.

[darius-dons.net.au]

Fix whitespace.

[rpokala]

sbin/mksnap_ffs/mksnap_ffs.8

52

What @mhorne said ; use .Pa and "directory". So that would be:

Typically, this is under the
.Pa .snap
directory in the root of the filesystem, but it can
be anywhere.

59

"sysem" -> "system"

[rpokala]

sbin/mksnap_ffs/mksnap_ffs.8

5

"under the"

• Sorry 🤦‍♂️

[darius-dons.net.au]

This time for sure!

[mckusick]

I concur with the revisions. Glad to see this being done.

[mhorne]

Thanks! :)