docs/94419: [patch] NanoBSD chapter for Handbook

[Jesus R. Camou]

The following reply was made to PR docs/94419; it has been noted by GNATS.

From: "Jesus R. Camou" <jcamou at FreeBSD.org>
To: Daniel Gerzo <danger at rulez.sk>
Cc: FreeBSD-gnats-submit at FreeBSD.org
Subject: Re: docs/94419: [patch] NanoBSD chapter for Handbook
Date: Mon, 13 Mar 2006 19:56:05 +0000

 An express review.
 
 On Mon, Mar 13, 2006 at 07:22:07PM +0000, Daniel Gerzo wrote:
 > <!--
 >      The FreeBSD Documentation Project
 >      $FreeBSD: $
 
 You mean $FreeBSD$ here.
 
 > -->
 > 
 > <chapter id="nanobsd">
 >   <chapterinfo>
 >     <authorgroup>
 >       <author>
 > 	<firstname>Daniel</firstname>
 > 	<surname>Gerzo</surname>
 > 	<contrib>Written by </contrib>
 > 	<!-- 13 March 2006 -->
 >       </author>
 >     </authorgroup>
 >   </chapterinfo>
 > 
 >   <title>NanoBSD</title>
 > 
 >   <sect1 id="nanobsd-intro">
 >     <title>Introduction to <application>NanoBSD</application></title>
 > 
 >     <para><application>NanoBSD</application> is tool currently
 
 `a tool'
 
 >       developed by &a.phk;.  It creates a &os; system image for embedded
 >       applications, suitable for use on a Compact Flash card (or other
 >       mass storage medium).</para>
 > 
 >     <para>It can probably be used to build a specialized server designed
 >       for easy installation and maintenance called computer applicance.
 >       Computer appliances have their hardware and software bundled in
 >       the product, so all applications are pre-installed.  The appliance
 
 s/so/which means/ perhaps?
 
 >       is plugged into an existing network and can begin working (almost)
 >       immediately.</para>
 > 
 >     <para>Features of <application>NanoBSD</application>:</para>
 > 
 >     <itemizedlist>
 >       <listitem>
 > 	<para>Ports and packages work like in &os;.</para>
 
 Probably s/like/as/ or something, or rewrite the whole sentence.
 
 >       </listitem>
 >       <listitem>
 > 	<para>No missing functionality — If it is possible to do
 > 	  with &os;, it is possible to do with
 > 	  <application>NanoBSD</application>, unless it was removed in
 > 	  compile time.</para>
 >       </listitem>
 >       <listitem>
 > 	<para>Everything is read-only at run-time — It is safe to
 > 	  pull the power-plug.  &man.fsck.8; is not necessary.</para>
 >       </listitem>
 >       <listitem>
 > 	<para>Easy to build and customize.</para>
 >       </listitem>
 >     </itemizedlist>
 >   </sect1>
 > 
 >   <sect1 id="nanobsd-howto">
 >     <title><application>NanoBSD</application> Howto</title>
 > 
 >     <sect2 id="nanobsd-design">
 >       <title>The design of <application>NanoBSD</application></title>
 > 
 >       <para>Once the image is present on the medium, it is possible to
 > 	boot the <application>NanoBSD</application>.  The mass storage
 	     ^^^
 Remove `the' here.
 
 > 	medium is divided into three parts, two image partitions -
 > 	<literal>code#1</literal> and <literal>code#2</literal>, and the
 > 	configuration file partition -
 > 	<filename role="directory">/cfg</filename>, which are normally
 > 	mounted read-only.  This means that it is safe to pull the power
 > 	plug on a <application>NanoBSD</application> machine and that
 > 	Flash based storage is not worn out with file system metadata
 > 	writes.</para>
 > 
 >       <para><filename role="directory">/etc</filename> and
 > 	<filename role="directory">/var</filename> directories are
 > 	&man.md.4; (malloc) disks.</para>
 > 
 >       <para>The configuration file partition persists under the <filename
 > 	role="directory">/cfg</filename> directory.  This partition
 > 	contains files for <filename role="directory">/etc</filename>
 > 	directory and is briefly mounted read-only right after the system
 > 	boot.  Note that this partition should be mounted only at
 > 	boot-time and while overriding the configuration files.</para>
 > 
 >       <para>After some modifications have been done in files in
 > 	<filename role="directory">/etc</filename> and they are proposed
 > 	to exist after next boot, it is required to copy them to the
 > 	<filename role="directoru">/cfg</filename> directory. For
 				                             ^^
 Double space after dot.
 
 You may want to take a look at some of the sentences for possible
 redundancies or better sentence options.
 
 - j