docs/112465: dumpfs.8: -m description incomprehensible
>Number: 112465
>Category: docs
>Synopsis: dumpfs.8: -m description incomprehensible
>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: Sun May 06 20:40:02 GMT 2007
>Closed-Date:
>Last-Modified:
>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:
>Unformatted:
_______________________________________________
freebsd-doc@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "freebsd-doc-unsubscribe@freebsd.org"