From chris@milan.hitnet.rwth-aachen.de  Wed Jul 24 04:37:55 2002
Return-Path: <chris@milan.hitnet.rwth-aachen.de>
Received: from mx1.FreeBSD.org (mx1.FreeBSD.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id 0F43D37B400
	for <FreeBSD-gnats-submit@freebsd.org>; Wed, 24 Jul 2002 04:37:55 -0700 (PDT)
Received: from milan.hitnet.rwth-aachen.de (milan.hitnet.RWTH-Aachen.DE [137.226.181.144])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 484A143E4A
	for <FreeBSD-gnats-submit@freebsd.org>; Wed, 24 Jul 2002 04:37:53 -0700 (PDT)
	(envelope-from chris@milan.hitnet.rwth-aachen.de)
Received: by milan.hitnet.rwth-aachen.de (Postfix, from userid 1001)
	id C5E95ABB3; Wed, 24 Jul 2002 13:37:43 +0200 (CEST)
Message-Id: <20020724113743.C5E95ABB3@milan.hitnet.rwth-aachen.de>
Date: Wed, 24 Jul 2002 13:37:43 +0200 (CEST)
From: Christian Brueffer <chris@unixpages.org>
Reply-To: Christian Brueffer <chris@unixpages.org>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: Various fixes for the solid-state article
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         40951
>Category:       docs
>Synopsis:       Various fixes for the solid-state article
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    brueffer
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed Jul 24 04:40:01 PDT 2002
>Closed-Date:    Thu Jan 16 17:41:27 CET 2003
>Last-Modified:  Thu Jan 16 17:41:27 CET 2003
>Originator:     Christian Brueffer
>Release:        FreeBSD 4.6-STABLE i386
>Organization:
>Environment:
System: FreeBSD milan.hitnet.rwth-aachen.de 4.6-STABLE FreeBSD 4.6-STABLE #2: Fri Jun 28 12:47:08 CEST 2002 chris@milan.hitnet.rwth-aachen.de:/usr/obj/usr/src/sys/LORIEN i386


	
>Description:
	Various fixes for the solid-state article, including typos
	and missing tags 
>How-To-Repeat:
	
>Fix:

	

--- patch begins here ---
--- article.sgml.orig	Wed Jul 24 12:33:57 2002
+++ article.sgml	Wed Jul 24 13:33:05 2002
@@ -134,7 +134,7 @@
     <para>First, all embedded FreeBSD systems that use flash memory as system
       disk will be interested in memory disks and memory filesystems.  Because
       of the limited number of writes that can be done to flash memory, the
-      disk and the filesystems no the disk will most likely be mounted
+      disk and the filesystems on the disk will most likely be mounted
       read-only.  In this environment, filesystems such as
       <filename>/tmp</filename> and <filename>/var</filename> are mounted as
       memory filesystems to allow the system to create logs and update
@@ -204,7 +204,7 @@
       read-only.  Remember that in <xref linkend="intro"> we detailed the
       limitations of flash memory - specifically the limited write capability.
       The importance of not mounting filesystems on flash media read-write,
-      and the importance of not using a swap file cannot be overstated.  A
+      and the importance of not using a swap file, cannot be overstated.  A
       swap file on a busy system can burn through a piece of flash media in
       less than one year. Heavy logging or temporary file creation and
       destruction can do the same.  Therefore, in addition to removing the
@@ -290,7 +290,7 @@
 	  by pressing the <keycap>w</keycap> key (this is a hidden option on
 	  this screen).  When presented with a menu to choose a boot manager,
 	  take care to select <literal>None</literal> if you are using an
-	  M-Systems Disk-On-Chip.  If you are using a ATA compatible compact
+	  M-Systems Disk-On-Chip.  If you are using an ATA compatible compact
 	  flash card, you should choose the FreeBSD Boot Manager.  Now press
 	  the <keycap>q</keycap> key to quit the partition menu.  You will be
 	  shown the boot manager menu once more - repeat the choice you made
@@ -333,8 +333,8 @@
 	  of the file from <literal>ESDI</literal> to
 	  <literal>DOC2K</literal>.  Next, regardless of whether you are using
 	  Disk-On-Chip or ATA compatible compact flash media, you need to add
-	  an a: line at the end of the file.  This <literal>a:</literal> line
-	  should look like:</para>
+	  an <literal>a:</literal> line at the end of the file.  This
+	  <literal>a:</literal> line should look like:</para>
 
 	<programlisting>a:      <replaceable>123456</replaceable>  0       4.2BSD  0       0</programlisting>
 
@@ -455,7 +455,7 @@
 
     <procedure>
       <step>
-	<para>Obtain an existing kern.flp image file</para>
+	<para>Obtain an existing <filename>kern.flp</filename> image file</para>
       </step>
 
       <step>
@@ -553,7 +553,7 @@
 
       <para>To make it possible to enter a ports directory and successfully
 	run <command>make install</command>, it is necessary for the file
-	<filename>/var/db/port.mkversion</filename> to exist, and that it have
+	<filename>/var/db/port.mkversion</filename> to exist, and that it has
 	a correct date in it.  Further, we must create a packages directory on
 	a non-memory filesystem that will keep track of our packages across
 	reboots. Because it is necessary to mount your filesystems as
@@ -599,8 +599,8 @@
 
       <para>Apache keeps pid files and logs in
 	<filename><replaceable>apache_install</replaceable>/logs</filename>.
-	Since this directory no doubt exists on a read-only filesystem, this
-	will not work.  It is necessary to add a new directory to the
+	Since this directory, without a doubt, exists on a read-only filesystem,
+	this will not work.  It is necessary to add a new directory to the
 	<filename>/etc/rc.diskless2</filename> list of directories to create
 	in <filename>/var</filename>, to link
 	<filename><replaceable>apache_install</replaceable>/logs</filename> to
--- patch ends here ---


>Release-Note:
>Audit-Trail:

From: Christian Brueffer <chris@unixpages.org>
To: FreeBSD-gnats-submit@FreeBSD.ORG
Cc:  
Subject: Re: docs/40951: Various fixes for the solid-state article
Date: Mon, 12 Aug 2002 18:34:44 +0000

 Ok, here are two new patches which incorporate the sentence
 Ceri Davies suggested.
 
 The first one contains the actual fixes, the second one contains
 whitespace fixes.
 
 
 
 --- article.sgml        Thu May 16 03:42:01 2002
 +++ article.sgml.modified       Mon Aug 12 18:06:27 2002
 @@ -134,7 +134,7 @@
      <para>First, all embedded FreeBSD systems that use flash memory as system
        disk will be interested in memory disks and memory filesystems.  Because
        of the limited number of writes that can be done to flash memory, the
 -      disk and the filesystems no the disk will most likely be mounted
 +      disk and the filesystems on the disk will most likely be mounted
        read-only.  In this environment, filesystems such as
        <filename>/tmp</filename> and <filename>/var</filename> are mounted as
        memory filesystems to allow the system to create logs and update
 @@ -204,7 +204,7 @@
        read-only.  Remember that in <xref linkend="intro"> we detailed the
        limitations of flash memory - specifically the limited write capability.
        The importance of not mounting filesystems on flash media read-write,
 -      and the importance of not using a swap file cannot be overstated.  A
 +      and the importance of not using a swap file, cannot be overstated.  A
        swap file on a busy system can burn through a piece of flash media in
        less than one year. Heavy logging or temporary file creation and
        destruction can do the same.  Therefore, in addition to removing the
 @@ -290,7 +290,7 @@
           by pressing the <keycap>w</keycap> key (this is a hidden option on
           this screen).  When presented with a menu to choose a boot manager,
           take care to select <literal>None</literal> if you are using an
 -         M-Systems Disk-On-Chip.  If you are using a ATA compatible compact
 +         M-Systems Disk-On-Chip.  If you are using an ATA compatible compact
           flash card, you should choose the FreeBSD Boot Manager.  Now press
           the <keycap>q</keycap> key to quit the partition menu.  You will be
           shown the boot manager menu once more - repeat the choice you made
 @@ -333,7 +333,7 @@
           of the file from <literal>ESDI</literal> to
           <literal>DOC2K</literal>.  Next, regardless of whether you are using
           Disk-On-Chip or ATA compatible compact flash media, you need to add
 -         an a: line at the end of the file.  This <literal>a:</literal> line
 +         an <literal>a:</literal> line at the end of the file.  This <literal>a:</literal> line
           should look like:</para>
  
         <programlisting>a:      <replaceable>123456</replaceable>  0       4.2BSD  0       0</programlisting>
 @@ -546,14 +546,11 @@
         your filesystems on the flash media.  Since they are read-only, you
         will need to temporarily mount them read-write using the mount syntax
         shown in <xref linkend="ro-fs">.  You should always remount those
 -       filesystems read-only when you are done with any maintenance - it is
 -       dangerous to leave them in read-write mode lest a process begin
 -       logging or otherwise writing regularly to the flash media and wearing
 -       it out over time.</para>
 +       filesystems read-only when you are done with any maintenance - unnecessary writes to the flash media could considerably shorten its lifespan.</para>
  
        <para>To make it possible to enter a ports directory and successfully
         run <command>make install</command>, it is necessary for the file
 -       <filename>/var/db/port.mkversion</filename> to exist, and that it have
 +       <filename>/var/db/port.mkversion</filename> to exist, and that it has
         a correct date in it.  Further, we must create a packages directory on
         a non-memory filesystem that will keep track of our packages across
         reboots. Because it is necessary to mount your filesystems as
 @@ -599,7 +596,7 @@
  
        <para>Apache keeps pid files and logs in
         <filename><replaceable>apache_install</replaceable>/logs</filename>.
 -       Since this directory no doubt exists on a read-only filesystem, this
 +       Since this directory, without a doubt, exists on a read-only filesystem, this
         will not work.  It is necessary to add a new directory to the
         <filename>/etc/rc.diskless2</filename> list of directories to create
         in <filename>/var</filename>, to link
 
 
 
 --- article.sgml.fixes  Mon Aug 12 18:22:46 2002
 +++ article.sgml.whitespace     Mon Aug 12 18:25:00 2002
 @@ -333,8 +333,8 @@
           of the file from <literal>ESDI</literal> to
           <literal>DOC2K</literal>.  Next, regardless of whether you are using
           Disk-On-Chip or ATA compatible compact flash media, you need to add
 -         an <literal>a:</literal> line at the end of the file.  This <literal>a:</literal> line
 -         should look like:</para>
 +         an <literal>a:</literal> line at the end of the file.  This
 +         <literal>a:</literal> line should look like:</para>
  
         <programlisting>a:      <replaceable>123456</replaceable>  0       4.2BSD  0       0</programlisting>
  
 @@ -546,7 +546,9 @@
         your filesystems on the flash media.  Since they are read-only, you
         will need to temporarily mount them read-write using the mount syntax
         shown in <xref linkend="ro-fs">.  You should always remount those
 -       filesystems read-only when you are done with any maintenance - unnecessary writes to the flash media could considerably shorten its lifespan.</para>
 +       filesystems read-only when you are done with any maintenance -
 +       unnecessary writes to the flash media could considerably shorten its
 +       lifespan.</para>
  
        <para>To make it possible to enter a ports directory and successfully
         run <command>make install</command>, it is necessary for the file
 @@ -596,8 +598,8 @@
  
        <para>Apache keeps pid files and logs in
         <filename><replaceable>apache_install</replaceable>/logs</filename>.
 -       Since this directory, without a doubt, exists on a read-only filesystem, this
 -       will not work.  It is necessary to add a new directory to the
 +       Since this directory, without a doubt, exists on a read-only filesystem,
 +       this will not work.  It is necessary to add a new directory to the
         <filename>/etc/rc.diskless2</filename> list of directories to create
         in <filename>/var</filename>, to link
         <filename><replaceable>apache_install</replaceable>/logs</filename> to
 
 
 
 - Christian
 
 -- 
 http://www.unixpages.org			chris@unixpages.org
 GPG Pub-Key    : www.unixpages.org/cbrueffer.asc
 GPG Fingerprint: 0DB5 8563 2473 C72A A8D1  56EA DAD2 B05D 5F3C 3185
 GPG Key ID     : DAD2B05D5F3C3185
Responsible-Changed-From-To: freebsd-doc->brueffer  
Responsible-Changed-By: brueffer 
Responsible-Changed-When: Mon Jan 13 10:26:20 PST 2003 
Responsible-Changed-Why:  
cleaning up my own mess :-) 

http://www.freebsd.org/cgi/query-pr.cgi?pr=40951 
State-Changed-From-To: open->closed 
State-Changed-By: brueffer 
State-Changed-When: Thu Jan 16 17:40:44 CET 2003 
State-Changed-Why:  
Commited 

http://www.freebsd.org/cgi/query-pr.cgi?pr=40951 
>Unformatted:
