[src/trunk]: src/sbin Improve documentation of FFS formats and format levels ...

[dholland <dholland%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/7b43a8147d4a
branches:  trunk
changeset: 764975:7b43a8147d4a
user:      dholland <dholland%NetBSD.org@localhost>
date:      Sat May 14 19:46:10 2011 +0000

description:
Improve documentation of FFS formats and format levels from PR 32100.
Prompted also by recent discussion on tech-kern. Bump date.

diffstat:

 sbin/fsck_ffs/fsck_ffs.8 |  18 ++++++++++++++++--
 sbin/newfs/newfs.8       |  18 ++++++++++++------
 2 files changed, 28 insertions(+), 8 deletions(-)

diffs (101 lines):

diff -r 61e6d10b38df -r 7b43a8147d4a sbin/fsck_ffs/fsck_ffs.8
--- a/sbin/fsck_ffs/fsck_ffs.8  Sat May 14 18:50:07 2011 +0000
+++ b/sbin/fsck_ffs/fsck_ffs.8  Sat May 14 19:46:10 2011 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: fsck_ffs.8,v 1.47 2011/04/29 10:34:52 wiz Exp $
+.\"    $NetBSD: fsck_ffs.8,v 1.48 2011/05/14 19:46:10 dholland Exp $
 .\"
 .\" Copyright (c) 1980, 1989, 1991, 1993
 .\"    The Regents of the University of California.  All rights reserved.
@@ -29,7 +29,7 @@
 .\"
 .\"    @(#)fsck.8      8.3 (Berkeley) 11/29/94
 .\"
-.Dd April 29, 2011
+.Dd May 14, 2011
 .Dt FSCK_FFS 8
 .Os
 .Sh NAME
@@ -173,20 +173,34 @@
 The file system is in the old (static table) format.
 .It 1
 The file system is in the new (dynamic table) format.
+Such file systems are made by using the
+.Fl O Ar 0
+option to
+.Xr newfs 8 .
 .It 2
 The file system supports 32-bit UIDs and GIDs,
 short symbolic links are stored in the inode,
 and directories have an added field showing the file type.
+This format was introduced in
+.Bx 4.4 .
 .It 3
 If maxcontig is greater than one,
 build the free segment maps to aid in finding contiguous sets of blocks.
 If maxcontig is equal to one, delete any existing segment maps.
+This was the default before
+.Nx 2.0 .
 .It 4
 Rearrange the super block to the same layout as FFSv2;
 disable the rotational layout tables and per cylinder group
 block totals.
+Such file systems are made by using the
+.Fl O Ar 1
+option to
+.Xr newfs 8 .
 .El
 .Pp
+Note that FFSv2 file systems are always level 4.
+.Pp
 In interactive mode,
 .Nm
 will list the conversion to be made
diff -r 61e6d10b38df -r 7b43a8147d4a sbin/newfs/newfs.8
--- a/sbin/newfs/newfs.8        Sat May 14 18:50:07 2011 +0000
+++ b/sbin/newfs/newfs.8        Sat May 14 19:46:10 2011 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: newfs.8,v 1.81 2011/03/06 17:20:28 wiz Exp $
+.\"    $NetBSD: newfs.8,v 1.82 2011/05/14 19:46:10 dholland Exp $
 .\"
 .\" Copyright (c) 1983, 1987, 1991, 1993, 1994
 .\"    The Regents of the University of California.  All rights reserved.
@@ -29,7 +29,7 @@
 .\"
 .\"     @(#)newfs.8    8.6 (Berkeley) 5/3/95
 .\"
-.Dd January 13, 2011
+.Dd May 14, 2011
 .Dt NEWFS 8
 .Os
 .Sh NAME
@@ -212,19 +212,25 @@
 .It 0
 4.3BSD; This option is primarily used to build root file systems that can be
 understood by older boot ROMs.
+This generates an FFSv1 file system with level 1 format.
 .It 1
-FFSv1; normal fast-filesystem (default).
-This is also known as
+FFSv1; normal Fast File System, level 4 format.
+Also known as
 .Sq FFS ,
 .Sq UFS ,
 or
 .Sq UFS1 .
+This is the default.
 .It 2
-FFSv2; enhanced fast-filesystem (suited for more than 1 Terabyte capacity,
-access control lists).
+FFSv2; enhanced Fast File System, suited for more than 1 Terabyte capacity.
+.\" Supports access control lists.
 This is also known as
 .Sq UFS2 .
 .El
+See
+.Xr fsck_ffs 8
+for more information about format levels.
+.Pp
 To create an LFS filesystem see
 .Xr newfs_lfs 8 .
 To create a Linux ext2 filesystem see