HomeFreeBSD

Clarify documentation of `zfs destroy` on snapshots (#17021)

Description

Clarify documentation of zfs destroy on snapshots (#17021)

The current documentation of zfs destroy in application to snapshots
is particularly difficult to understand. The following changes are made:

  • Remove circular reference to zfs destroy in the documentation of that command.
  • Remove use of "for example", which implies there are more, undocumented reasons that ZFS may fail to destroy a snapshot immediately.
  • Mention properties defer_destroy and userrefs.
  • Add zfsprops(8) to "SEE ALSO" list.
  • Clarify meaning of -d option.

Requires-builders: none

Signed-off-by: mnrx <83848843+mnrx@users.noreply.github.com>
Co-authored-by: Alexander Motin <mav@FreeBSD.org>
Reviewed-by: Alexander Motin <mav@FreeBSD.org>
Reviewed-by: George Amanakis <gamanakis@gmail.com>
Reviewed-by: Tony Hutter <hutter2@llnl.gov>

Details

Provenance
mnrx <83848843+mnrx@users.noreply.github.com>Authored on Feb 5 2025, 10:47 PM
GitHub <noreply@github.com>Committed on Feb 5 2025, 10:47 PM
Parents
rG2ca91ba3cf20: Linux 6.14: BLK_MQ_F_SHOULD_MERGE was removed
Branches
Unknown
Tags
Unknown

Event Timeline

GitHub <noreply@github.com> committed rG0be1da26cb4f: Clarify documentation of `zfs destroy` on snapshots (#17021) (authored by mnrx <83848843+mnrx@users.noreply.github.com>).Feb 5 2025, 10:47 PM