From owner-svn-src-projects@FreeBSD.ORG Sat Mar 17 03:28:37 2012 Return-Path: Delivered-To: svn-src-projects@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [69.147.83.52]) by hub.freebsd.org (Postfix) with ESMTP id EBDB5106566B; Sat, 17 Mar 2012 03:28:37 +0000 (UTC) (envelope-from gber@FreeBSD.org) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:4f8:fff6::2c]) by mx1.freebsd.org (Postfix) with ESMTP id D15AA8FC16; Sat, 17 Mar 2012 03:28:37 +0000 (UTC) Received: from svn.freebsd.org (localhost [127.0.0.1]) by svn.freebsd.org (8.14.4/8.14.4) with ESMTP id q2H3SbEV048269; Sat, 17 Mar 2012 03:28:37 GMT (envelope-from gber@svn.freebsd.org) Received: (from gber@localhost) by svn.freebsd.org (8.14.4/8.14.4/Submit) id q2H3SbfX048266; Sat, 17 Mar 2012 03:28:37 GMT (envelope-from gber@svn.freebsd.org) Message-Id: <201203170328.q2H3SbfX048266@svn.freebsd.org> From: Grzegorz Bernacki Date: Sat, 17 Mar 2012 03:28:37 +0000 (UTC) To: src-committers@freebsd.org, svn-src-projects@freebsd.org X-SVN-Group: projects MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Cc: Subject: svn commit: r233074 - projects/nand/share/man/man5 X-BeenThere: svn-src-projects@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "SVN commit messages for the src " projects" tree" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 17 Mar 2012 03:28:38 -0000 Author: gber Date: Sat Mar 17 03:28:37 2012 New Revision: 233074 URL: http://svn.freebsd.org/changeset/base/233074 Log: Add manual pages for NANDFS. Obtained from: Semihalf Supported by: FreeBSD Foundation, Juniper Networks Added: projects/nand/share/man/man5/nandfs.5 Modified: projects/nand/share/man/man5/Makefile Modified: projects/nand/share/man/man5/Makefile ============================================================================== --- projects/nand/share/man/man5/Makefile Sat Mar 17 03:23:13 2012 (r233073) +++ projects/nand/share/man/man5/Makefile Sat Mar 17 03:28:37 2012 (r233074) @@ -85,6 +85,10 @@ MLINKS+=resolver.5 resolv.conf.5 MAN+= hesiod.conf.5 .endif +.if ${MK_NAND} != "no" +MAN+= nandfs.5 +.endif + .if ${MACHINE_CPUARCH} == "amd64" || ${MACHINE_CPUARCH} == "i386" _boot.config.5= boot.config.5 .endif Added: projects/nand/share/man/man5/nandfs.5 ============================================================================== --- /dev/null 00:00:00 1970 (empty, because file is newly added) +++ projects/nand/share/man/man5/nandfs.5 Sat Mar 17 03:28:37 2012 (r233074) @@ -0,0 +1,131 @@ +.\" +.\" Copyright (c) 2010 Semihalf +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd Nov 11, 2010 +.Dt NANDFS 5 +.Os +.Sh NAME +.Nm nandfs +.Nd NAND Flash file system +.Sh SYNOPSIS +To compile support for the +.Nm , +place the following in your kernel configuration file: +.Bd -ragged -offset indent +.Cd "options NANDFS" +.Ed +.Pp +Even though the NAND FS can be used with any storage media, it has been +optimized and designed towards NAND Flash devices, so typically the following +driver is used: +.Bd -ragged -offset indent +.Cd "device nand" +.Ed +.Sh DESCRIPTION +The +.Nm +driver enables +.Fx +with support for NAND-oriented file system. +.Pp +It is a log-structured style file system with the following major features and +characteristics: +.Bl -bullet +.It +Hard links, symbolic links support +.It +Block journaling +.It +Copy-On-Write +.It +Snapshots (continuous, taken automatically, simultaneously mountable) +.It +Quick crash recovery at mount time +.It +64-bit data structures; supports many files, large files and volumes +.It +POSIX file permissions +.It +Checksum / ECC +.El +.Sh EXAMPLES +The most common usage is mounting the file system: +.Pp +.Dl "mount -t nandfs /dev/ /mnt" +.Pp +or: +.Dl "mount_nandfs /dev/ /mnt" +.Pp +where +.Ar gnandN +is the GEOM device representing a Flash partition (slice) containing the +.Nm +structure, and +.Pa /mnt +is a mount point. +.Pp +.Pp +It is possible to define an entry in +.Pa /etc/fstab +for the +.Nm : +.Bd -literal +/dev/gnand0 /flash nandfs rw 0 0 +.Ed +.Pp +This will mount a +.Nm +partition at the specified mount point during system boot. +.Sh SEE ALSO +.Xr gnand 4 , +.Xr nand 4 , +.Xr nandfs_cleanerd.conf 5 , +.Xr cleanerd 8 , +.Xr mount_nandfs 8 , +.Xr nandfs 8 , +.Xr nandsim 8 , +.Xr nandtool 8 , +.Xr umount_nandfs 8 +.Sh HISTORY +The NAND FS concepts are based on NILFS principles and initial implementation +was derived from early NILFS NetBSD code (read only). Since then the NAND FS +code diverged significantly and is by no means compatible with NILFS. +.Pp +The NAND Flash file system first appeared in +.Fx 10.0 . +.Sh AUTHOR +The NAND FS was written by +.An Grzegorz Bernacki with the help of +.An Mateusz Guzik , +based on the NetBSD code created by +.An Reinoud Zandijk . +Additional help and support by +.An Lukasz Plachno , +.An Jan Sieka and +.An Lukasz Wojcik . +This manual page was written by +.An Rafal Jaworowski .