From nobody@FreeBSD.org  Fri Feb 13 01:53:45 2009
Return-Path: <nobody@FreeBSD.org>
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id C75AB10658AE
	for <freebsd-gnats-submit@FreeBSD.org>; Fri, 13 Feb 2009 01:53:45 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from www.freebsd.org (www.freebsd.org [IPv6:2001:4f8:fff6::21])
	by mx1.freebsd.org (Postfix) with ESMTP id B4D0C8FC1F
	for <freebsd-gnats-submit@FreeBSD.org>; Fri, 13 Feb 2009 01:53:45 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from www.freebsd.org (localhost [127.0.0.1])
	by www.freebsd.org (8.14.3/8.14.3) with ESMTP id n1D1rjiC032274
	for <freebsd-gnats-submit@FreeBSD.org>; Fri, 13 Feb 2009 01:53:45 GMT
	(envelope-from nobody@www.freebsd.org)
Received: (from nobody@localhost)
	by www.freebsd.org (8.14.3/8.14.3/Submit) id n1D1rjea032267;
	Fri, 13 Feb 2009 01:53:45 GMT
	(envelope-from nobody)
Message-Id: <200902130153.n1D1rjea032267@www.freebsd.org>
Date: Fri, 13 Feb 2009 01:53:45 GMT
From: Andrew Wright <andrew@qemg.org>
To: freebsd-gnats-submit@FreeBSD.org
Subject: dump(8) "recommended" cache option confusing
X-Send-Pr-Version: www-3.1
X-GNATS-Notify:

>Number:         131626
>Category:       docs
>Synopsis:       [patch] 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:  Fri Jul 16 11:02:36 UTC 2010
>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@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:
Responsible-Changed-From-To: freebsd-doc->pgj 
Responsible-Changed-By: pgj 
Responsible-Changed-When: Fri Feb 13 06:33:44 UTC 2009 
Responsible-Changed-Why:  
Take 

http://www.freebsd.org/cgi/query-pr.cgi?pr=131626 

From: Andrew Hamilton-Wright <andrewhw@ieee.org>
To: bug-followup@FreeBSD.org, Andrew Hamilton-Wright <andrew@qemg.org>
Cc:  
Subject: Re: docs/131626: [patch] dump(8) "recommended" cache option
 confusing
Date: Fri, 13 Feb 2009 08:20:46 -0400 (AST)

   This message is in MIME format.  The first part should be readable text,
   while the remaining parts are likely unreadable without MIME-aware tools.
 
 --142510029-816157110-1234527646=:12848
 Content-Type: TEXT/PLAIN; format=flowed; charset=US-ASCII
 
 
 Oops; path in patch referenced /tmp, not relative path in /usr/src.
 
 Updated patch attached.
 
 Andrew.
 
 --142510029-816157110-1234527646=:12848
 Content-Type: TEXT/PLAIN; charset=US-ASCII; name=dump.8.patch.txt
 Content-Transfer-Encoding: BASE64
 Content-Description: 
 Content-Disposition: attachment; filename=dump.8.patch.txt
 
 LS0tIGR1bXAuOAkyMDA5LTAxLTA5IDEzOjA3OjI2LjAwMDAwMDAwMCAtMDQw
 MA0KKysrIHNiaW4vZHVtcC9kdW1wLjgJMjAwOS0wMi0xMiAyMTo1MjowMy4w
 MDAwMDAwMDAgLTA0MDANCkBAIC0xMzYsOSArMTM2LDExIEBADQogVGhpcyB3
 aWxsIGdyZWF0bHkgaW1wcm92ZSBwZXJmb3JtYW5jZQ0KIGF0IHRoZSBjb3N0
 IG9mDQogLk5tDQotcG9zc2libHkgbm90IG5vdGljaW5nIGNoYW5nZXMgaW4g
 dGhlIGZpbGUgc3lzdGVtIGJldHdlZW4gcGFzc2VzLg0KLUl0IGlzDQotcmVj
 b21tZW5kZWQgdGhhdCB5b3UgYWx3YXlzIHVzZSB0aGlzIG9wdGlvbiB3aGVu
 IGR1bXBpbmcgYSBzbmFwc2hvdC4NCitwb3NzaWJseSBub3Qgbm90aWNpbmcg
 Y2hhbmdlcyBpbiB0aGUgZmlsZSBzeXN0ZW0gYmV0d2VlbiBwYXNzZXMNCit1
 bmxlc3MgYSBzbmFwc2hvdCBpcyBiZWluZyB1c2VkLg0KK1RoZSBwb3RlbnRp
 YWwgZm9yIHBlcmZvcm1hbmNlIGltcHJvdmVtZW50IGluZGljYXRlcyB0aGF0
 DQordXNlIG9mIHRoaXMgb3B0aW9uIHRvZ2V0aGVyIHdpdGggc25hcHNob3Rz
 IGlzIHRoZSByZWNvbW1lbmRlZA0KK2NvdXJzZSBvZiBhY3Rpb24uDQogQmV3
 YXJlIHRoYXQNCiAuTm0NCiBmb3JrcywgYW5kIHRoZSBhY3R1YWwgbWVtb3J5
 IHVzZSBtYXkgYmUgbGFyZ2VyIHRoYW4gdGhlIHNwZWNpZmllZCBjYWNoZQ0K
 
 --142510029-816157110-1234527646=:12848--
Responsible-Changed-From-To: pgj->freebsd-doc 
Responsible-Changed-By: pgj 
Responsible-Changed-When: Fri Jul 16 11:02:17 UTC 2010 
Responsible-Changed-Why:  
Back to the pool. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=131626 
>Unformatted:
