[src/trunk]: src/sbin/mount_nilfs Improved documentation of mount_nilfs, from...

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

details:   https://anonhg.NetBSD.org/src/rev/f4b7bc23c135
branches:  trunk
changeset: 815741:f4b7bc23c135
user:      pgoyette <pgoyette%NetBSD.org@localhost>
date:      Wed Jun 01 11:56:49 2016 +0000

description:
Improved documentation of mount_nilfs, from PR bin/46730

diffstat:

 sbin/mount_nilfs/mount_nilfs.8 |  31 +++++++++++++++++++++++++++----
 1 files changed, 27 insertions(+), 4 deletions(-)

diffs (57 lines):

diff -r 8f983e2a300f -r f4b7bc23c135 sbin/mount_nilfs/mount_nilfs.8
--- a/sbin/mount_nilfs/mount_nilfs.8    Wed Jun 01 11:28:45 2016 +0000
+++ b/sbin/mount_nilfs/mount_nilfs.8    Wed Jun 01 11:56:49 2016 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: mount_nilfs.8,v 1.2 2009/07/18 17:07:12 wiz Exp $
+.\" $NetBSD: mount_nilfs.8,v 1.3 2016/06/01 11:56:49 pgoyette Exp $
 .\"
 .\" Copyright (c) 2008, 2009 Reinoud Zandijk
 .\" All rights reserved.
@@ -32,7 +32,7 @@
 .\"
 .\" <<Id: LICENSE,v 1.2 2000/06/14 15:57:33 cgd Exp>>
 .\"
-.Dd July 13, 2009
+.Dd June 1, 2016
 .Dt MOUNT_NILFS 8
 .Os
 .Sh NAME
@@ -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,24 @@
 .Xr fstab 5 ,
 .Xr mount 8 ,
 .Xr umount 8 ,
+.Xr mount_lfs 8 ,
 .Xr vnconfig 8
-.Sh NOTES
-NILFS is a file system developped by NTT and is currently in version 2.
+.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
+.An -nosplit
+.An 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
+.An 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.