bin/46730: Improve mount_nilfs.8 (-current, netbsd-6)

[Matthew Mondor <mm_lists%pulsar-zone.net@localhost>]

>Number:         46730
>Category:       bin
>Synopsis:       Improve mount_nilfs.8 (-current, netbsd-6)
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    bin-bug-people
>State:          open
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Sat Jul 21 07:40:00 +0000 2012
>Originator:     Matthew Mondor
>Release:        NetBSD 6.0_BETA2, -current
>Organization:
>Environment:
System: NetBSD ninja.xisop 6.0_BETA2 NetBSD 6.0_BETA2 (GENERIC_MM) #18: Wed Jul 
4 20:43:55 EDT 2012 root@ninja.xisop:/usr/obj/sys/arch/amd64/compile/GENERIC_MM 
amd64
Architecture: x86_64
Machine: amd64
>Description:

When someone asked about if writing to nilfs was like writing to null
(which might have been a joke considering the current implementation
only supports read-only operations, but who knows, considering its
name :), I wondered what it was about, as the manual page had very
little information, and I had to search the web to find out...

>How-To-Repeat:
>Fix:

Proposed diff attached for review


--MP_/ctRy/SOHwdLawmf/xIDz6L3
Content-Type: text/plain
Content-Transfer-Encoding: 7bit
Content-Disposition: attachment; filename=nilfs-diff.txt

Index: sbin/mount_nilfs/mount_nilfs.8
===================================================================
RCS file: /data/rsync/netbsd-cvs/src/sbin/mount_nilfs/mount_nilfs.8,v
retrieving revision 1.2
diff -u -r1.2 mount_nilfs.8
--- sbin/mount_nilfs/mount_nilfs.8      18 Jul 2009 17:07:12 -0000      1.2
+++ sbin/mount_nilfs/mount_nilfs.8      21 Jul 2012 07:27:51 -0000
@@ -46,6 +46,11 @@
 .Ar special
 .Ar node
 .Sh DESCRIPTION
+NILFS is a log-structured file system designed to support fast
+writing, fast recovery times, live snapshots, concurrent read-only
+snapshot mounts, and live file system resizing.  Its inodes are
+managed using B-trees.
+.Pp
 The
 .Nm
 command attaches the NILFS file system residing on the specified
@@ -75,6 +80,21 @@
 .Xr fstab 5 ,
 .Xr mount 8 ,
 .Xr umount 8 ,
-.Xr vnconfig 8
-.Sh NOTES
-NILFS is a file system developped by NTT and is currently in version 2.
+.Xr vnconfig 8,
+.Xr mount_lfs 8
+.Sh HISTORY
+NILFS is a file system developped by NTT and released in 2005 for
+Linux.  Version 2 is available since 2009.
+This cleanroom implementation was written by Reinoud Zandijk for
+NetBSD in 2009, and has first been released as part of NetBSD 6.
+.Sh AUTHORS
+This implementation of NILFS was written by Reinoud Zandijk.
+.Sh CAVEATS
+This implementation currently only supports read-only operation.
+See
+.Xr mount_lfs 8
+for an older log-structured file system with write support.  Also see
+.Xr wapbl 4
+and
+.Xr mount 8
+for fast journal-based recovery using FFS.

--MP_/ctRy/SOHwdLawmf/xIDz6L3--

>Unformatted:
 --MP_/ctRy/SOHwdLawmf/xIDz6L3
 Content-Type: text/plain; charset=US-ASCII
 Content-Transfer-Encoding: 7bit
 Content-Disposition: inline