Bug 33043

Summary: Minor changes to Chapter 3 of the handbook.
Product: Documentation Reporter: Ashley Penney <ashp>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Ashley Penney 2001-12-21 01:10:00 UTC
I felt the documentation in 3.4.1 for the fstab fields wasn't as complete towards the end as it should be, two entries were rolled into one.

Fix: 

-         <listitem><para>The number of days the filesystem should be
-             dumped, and <literal>passno</literal> is the pass number
-             during which the filesystem is checked during the boot
-             sequence.</para>
+         <listitem><para>This is used by dump to determine which
+             filesystems require dumping.  If the field is missing,
+             a value of zero is assumed.</para>
+         </listitem>
+       </varlistentry>
+
+       <varlistentry>
+         <term><literal>passno</literal></term>
+
+         <listitem><para>This determines the order in which filesystems
+             should be checked.  The root filesystem should be set to one,
+             other filesystems to two, and filesystems that should be
+             skipped set to zero.
          </listitem>
        </varlistentry>
       </variablelist>--E6nVNVGusCrP5AbQKijL3SGNIDxb7RT5V0zaPSjrcdFxKQoN
Content-Type: text/plain; name="file.diff"
Content-Transfer-Encoding: 7bit
Content-Disposition: attachment; filename="file.diff"

--- chapter.sgml.old    Thu Dec 20 20:00:39 2001
+++ chapter.sgml        Thu Dec 20 20:06:14 2001
@@ -535,10 +535,19 @@
        <varlistentry>
          <term><literal>dumpfreq</literal></term>
Comment 1 Giorgos Keramidas 2002-01-06 01:19:08 UTC
On 2001-12-20 17:07:21, Ashley Penney wrote:
> 
> I felt the documentation in 3.4.1 for the fstab fields wasn't as
> complete towards the end as it should be, two entries were rolled
> into one.

> >Fix:
> --- chapter.sgml.old    Thu Dec 20 20:00:39 2001
> +++ chapter.sgml        Thu Dec 20 20:06:14 2001
> @@ -535,10 +535,19 @@
>         <varlistentry>
>           <term><literal>dumpfreq</literal></term>
> 
> -         <listitem><para>The number of days the filesystem should be
> -             dumped, and <literal>passno</literal> is the pass number
> -             during which the filesystem is checked during the boot
> -             sequence.</para>
> +         <listitem><para>This is used by dump to determine which
> +             filesystems require dumping.  If the field is missing,
> +             a value of zero is assumed.</para>
> +         </listitem>
> +       </varlistentry>
> +
> +       <varlistentry>
> +         <term><literal>passno</literal></term>
> +
> +         <listitem><para>This determines the order in which filesystems
> +             should be checked.  The root filesystem should be set to one,
> +             other filesystems to two, and filesystems that should be
> +             skipped set to zero.

I am still catching up with my mail, so if this has already been
committed please pardon me.

Ashley, this looks nice.

Do you think we could add a bit to passno's description that would
explain why the ``magical'' values of 1 and 2 should be used?  Perhaps
something like:

        <listitem>
	  <para>This determines the order in which filesystems should
	    be checked.  Filesystems that should be skipped should
	    have their <literal>passno</literal> set to zero.  The
	    root filesystem (which needs to be checked before
	    everything else) should have it's
	    <literal>passno</literal> set to one, and other
	    filesystems' <literal>passno</literal> should be set to
	    values greater than one.  If more than one filesystems
	    have the same <literal>passno</literal> then &man.fsck.8;
	    will attempt to check filesystems in parallel if
	    possible.</para>
	  </listitem>

Does this look any better, Ashley?
Other suggestions anyone?

-giorgos

PS: I know that the manpage of fstab(5) uses the ``magical'' values of
    1 and 2 too.  A quick glance to the src/sbin/fsck sources and I
    see that there is nothing magical about 2.  Perhaps we should also
    change fstab.5 to read "greater than one" instead of 2.
Comment 2 Giorgos Keramidas 2002-01-11 02:45:43 UTC
Adding to the audit trail.

  On 2002-01-10 21:23:14, Ashley Penney wrote:
  > On Fri, Jan 11, 2002 at 02:23:44AM +0200, Giorgos Keramidas said:
  > > On 2002-01-06 14:24:16, Ashley Penney wrote:
  > > > On Sun, Jan 06, 2002 at 03:19:08AM +0200, Giorgos Keramidas said:
  > > > >
  > > > > Does this look any better, Ashley?
  > > > > Other suggestions anyone?
  > > >
  > > > Looks better to me, and should make more sense to the reader. :)
  > >
  > > Hello Ashley,
  > >
  > > ...so, should I go ahead and add this, with the rest of your text
  > > about dump frequency?
  >
  > As long as you're happy with the resulting content, sure!

-- 
Giorgos Keramidas . . . . . . . . . keramida@{ceid.upatras.gr,freebsd.org}
FreeBSD Documentation Project . . . http://www.freebsd.org/docproj/
FreeBSD: The power to serve . . . . http://www.freebsd.org/
Comment 3 Giorgos Keramidas freebsd_committer freebsd_triage 2002-01-11 02:50:52 UTC
State Changed
From-To: open->closed

The handbook has been updated with the new text, in revision 1.54 of 
doc/en_US.ISO8859-1/books/handbook/basics/chapter.sgml 
Soon the changes should appear on the Web too.