docs/131626: dump(8) "recommended" cache option confusing

[Andrew Wright]

>Number:         131626
>Category:       docs
>Synopsis:       dump(8) "recommended" cache option confusing
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Fri Feb 13 02:00:07 UTC 2009
>Closed-Date:
>Last-Modified:
>Originator:     Andrew Wright
>Release:        7.1
>Organization:
Mount Allison University
>Environment:
FreeBSD qemg.org 7.1-RELEASE-p1 FreeBSD 7.1-RELEASE-p1 #9: Tue Jan 13 21:17:15 AST 2009     root at qemg.org:/usr/obj/usr/src/sys/GENERIC  amd64

>Description:
The description of the "recommended" use of cache and snapshots in dump(8) is somewhat confusing, as the reason for the recommendation is left unclear.
>How-To-Repeat:
See docs for dump(8) option "C" -> cache size.
>Fix:
Doc update, patch attached.

Patch attached with submission follows:

--- dump.8	2009-01-09 13:07:26.000000000 -0400
+++ /tmp/dump.8	2009-02-12 21:52:03.000000000 -0400
@@ -136,9 +136,11 @@
 This will greatly improve performance
 at the cost of
 .Nm
-possibly not noticing changes in the file system between passes.
-It is
-recommended that you always use this option when dumping a snapshot.
+possibly not noticing changes in the file system between passes
+unless a snapshot is being used.
+The potential for performance improvement indicates that
+use of this option together with snapshots is the recommended
+course of action.
 Beware that
 .Nm
 forks, and the actual memory use may be larger than the specified cache


>Release-Note:
>Audit-Trail:
>Unformatted: