From naddy@mips.inka.de  Sun May  6 20:30:29 2007
Return-Path: <naddy@mips.inka.de>
Received: from mx1.freebsd.org (mx1.freebsd.org [69.147.83.52])
	by hub.freebsd.org (Postfix) with ESMTP id 084E316A401
	for <FreeBSD-gnats-submit@freebsd.org>; Sun,  6 May 2007 20:30:29 +0000 (UTC)
	(envelope-from naddy@mips.inka.de)
Received: from mail-in-12.arcor-online.net (mail-in-12.arcor-online.net [151.189.21.52])
	by mx1.freebsd.org (Postfix) with ESMTP id 8AE3213C44B
	for <FreeBSD-gnats-submit@freebsd.org>; Sun,  6 May 2007 20:30:28 +0000 (UTC)
	(envelope-from naddy@mips.inka.de)
Received: from mail-in-01-z2.arcor-online.net (mail-in-10-z2.arcor-online.net [151.189.8.27])
	by mail-in-12.arcor-online.net (Postfix) with ESMTP id AD256844CB
	for <FreeBSD-gnats-submit@freebsd.org>; Sun,  6 May 2007 18:12:10 +0200 (CEST)
Received: from mail-in-05.arcor-online.net (mail-in-05.arcor-online.net [151.189.21.45])
	by mail-in-01-z2.arcor-online.net (Postfix) with ESMTP id A1A6A23D3A8
	for <FreeBSD-gnats-submit@freebsd.org>; Sun,  6 May 2007 18:12:10 +0200 (CEST)
Received: from kemoauc.mips.inka.de (dslb-088-066-015-130.pools.arcor-ip.net [88.66.15.130])
	by mail-in-05.arcor-online.net (Postfix) with ESMTP id 696E62BAA2D
	for <FreeBSD-gnats-submit@freebsd.org>; Sun,  6 May 2007 18:12:10 +0200 (CEST)
Received: from kemoauc.mips.inka.de (localhost [127.0.0.1])
	by kemoauc.mips.inka.de (8.13.8/8.12.10) with ESMTP id l46GC9Bu089887
	for <FreeBSD-gnats-submit@freebsd.org>; Sun, 6 May 2007 18:12:09 +0200 (CEST)
	(envelope-from naddy@kemoauc.mips.inka.de)
Received: (from naddy@localhost)
	by kemoauc.mips.inka.de (8.13.8/8.13.8/Submit) id l46GC9HY089886;
	Sun, 6 May 2007 18:12:09 +0200 (CEST)
	(envelope-from naddy)
Message-Id: <200705061612.l46GC9HY089886@kemoauc.mips.inka.de>
Date: Sun, 6 May 2007 18:12:09 +0200 (CEST)
From: Christian Weisgerber <naddy@freebsd.org>
Reply-To: Christian Weisgerber <naddy@freebsd.org>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: dumpfs.8: -m description incomprehensible
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         112465
>Category:       docs
>Synopsis:       [patch] dumpfs.8: -m description incomprehensible
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    pav
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sun May 06 20:40:02 GMT 2007
>Closed-Date:    Sat May 19 11:32:57 GMT 2007
>Last-Modified:  Sat May 19 11:32:57 GMT 2007
>Originator:     Christian Weisgerber
>Release:        FreeBSD 5.5-STABLE alpha
>Organization:
>Environment:
System: FreeBSD kemoauc.mips.inka.de 5.5-STABLE FreeBSD 5.5-STABLE #0: Sat Apr 7 02:46:16 CEST 2007 naddy@kemoauc.mips.inka.de:/usr/obj/usr/src/sys/GENERIC alpha

(This applies to -CURRENT just the same.)

>Description:

Currently, the -m option to dumpfs is described in dumpfs.8 like this:

     If -m is specified, the file system is marshalled in terms of a newfs(8)
     command to generate the file system.

This is incomprehensible.

OpenBSD has recently ported the functionality from FreeBSD and
modified the man page description:

     If -m is specified, a newfs(8) command is output that can be used to gen-
     erate a new file system with equivalent settings.

I suggest that our dumpfs.8 adopt the same phrasing.  This loses
the mnemonic value of -m, but clearness should be more important.

>How-To-Repeat:

>Fix:

Index: dumpfs.8
===================================================================
RCS file: /home/ncvs/src/sbin/dumpfs/dumpfs.8,v
retrieving revision 1.15
diff -u -r1.15 dumpfs.8
--- dumpfs.8	10 Feb 2005 09:19:28 -0000	1.15
+++ dumpfs.8	6 May 2007 16:03:08 -0000
@@ -53,9 +53,10 @@
 .Pp
 If
 .Fl m
-is specified, the file system is marshalled in terms of a
+is specified, a
 .Xr newfs 8
-command to generate the file system.
+command is output that can be used to generate a new file system
+with equivalent settings.
 .Sh SEE ALSO
 .Xr disktab 5 ,
 .Xr fs 5 ,

>Release-Note:
>Audit-Trail:
State-Changed-From-To: open->patched 
State-Changed-By: pav 
State-Changed-When: Sat May 12 22:28:21 UTC 2007 
State-Changed-Why:  
Committed (I changed output for printed, output sounds awkward IMHO). 


Responsible-Changed-From-To: freebsd-doc->pav 
Responsible-Changed-By: pav 
Responsible-Changed-When: Sat May 12 22:28:21 UTC 2007 
Responsible-Changed-Why:  
Will MFC later 

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

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/112465: commit references a PR
Date: Sat, 12 May 2007 22:35:28 +0000 (UTC)

 pav         2007-05-12 22:35:22 UTC
 
   FreeBSD src repository (doc,ports committer)
 
   Modified files:
     sbin/dumpfs          dumpfs.8 
   Log:
   Replace incomprehensive description of -m by much clearer text from OpenBSD,
   with the exception of one word.
   
   PR:             docs/112465
   Submitted by:   naddy
   Obtained from:  OpenBSD
   MFC after:      1 week
   
   Revision  Changes    Path
   1.16      +3 -2      src/sbin/dumpfs/dumpfs.8
 _______________________________________________
 cvs-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/cvs-all
 To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
 
State-Changed-From-To: patched->closed 
State-Changed-By: pav 
State-Changed-When: Sat May 19 11:32:44 UTC 2007 
State-Changed-Why:  
MFC'ed. 

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