git: 70a2e109bd48 - main - dump(8): clarify the recommended use of cache and snapshots

[Guangyuan Yang]

The branch main has been updated by ygy (doc committer):

URL: https://cgit.FreeBSD.org/src/commit/?id=70a2e109bd486f97e6fa5f969be9d90e404de016

commit 70a2e109bd486f97e6fa5f969be9d90e404de016
Author:     Guangyuan Yang <ygy at FreeBSD.org>
AuthorDate: 2020-12-28 21:54:36 +0000
Commit:     Guangyuan Yang <ygy at FreeBSD.org>
CommitDate: 2020-12-28 21:56:58 +0000

    dump(8): clarify the recommended use of cache and snapshots
    
    PR:             131626
    MFC after:      1 week
    Submitted by:   Andrew Hamilton-Wright <andrew at qemg.org>
    Reviewed by:    bcr
    Differential Revision:  https://reviews.freebsd.org/D27775
---
 sbin/dump/dump.8 | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/sbin/dump/dump.8 b/sbin/dump/dump.8
index 56aea04551f8..80e8eae21d19 100644
--- a/sbin/dump/dump.8
+++ b/sbin/dump/dump.8
@@ -29,7 +29,7 @@
 .\"     @(#)dump.8	8.3 (Berkeley) 5/1/95
 .\" $FreeBSD$
 .\"
-.Dd June 13, 2019
+.Dd December 28, 2020
 .Dt DUMP 8
 .Os
 .Sh NAME
@@ -134,9 +134,11 @@ Specify the cache size in megabytes.
 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