From owner-dev-commits-src-main@freebsd.org Mon Dec 28 21:57:14 2020 Return-Path: Delivered-To: dev-commits-src-main@mailman.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.nyi.freebsd.org (Postfix) with ESMTP id 9AFDE4C2C9E; Mon, 28 Dec 2020 21:57:14 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4D4WcB3rYsz4n6w; Mon, 28 Dec 2020 21:57:14 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 72A632084D; Mon, 28 Dec 2020 21:57:14 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 0BSLvE59005347; Mon, 28 Dec 2020 21:57:14 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 0BSLvElX005346; Mon, 28 Dec 2020 21:57:14 GMT (envelope-from git) Date: Mon, 28 Dec 2020 21:57:14 GMT Message-Id: <202012282157.0BSLvElX005346@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Guangyuan Yang Subject: git: 70a2e109bd48 - main - dump(8): clarify the recommended use of cache and snapshots MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: ygy X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 70a2e109bd486f97e6fa5f969be9d90e404de016 Auto-Submitted: auto-generated X-BeenThere: dev-commits-src-main@freebsd.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: "Commit messages for the main branch of the src repository." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 28 Dec 2020 21:57:14 -0000 The branch main has been updated by ygy (doc committer): URL: https://cgit.FreeBSD.org/src/commit/?id=70a2e109bd486f97e6fa5f969be9d90e404de016 commit 70a2e109bd486f97e6fa5f969be9d90e404de016 Author: Guangyuan Yang AuthorDate: 2020-12-28 21:54:36 +0000 Commit: Guangyuan Yang 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 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