docs/52547: [patch] Cleanup of laptop article

[Marc Fonvieille]

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

From: Marc Fonvieille <blackend at FreeBSD.org>
To: "Simon L.Nielsen" <simon at nitro.dk>
Cc: FreeBSD-gnats-submit at FreeBSD.org
Subject: Re: docs/52547: [patch] Cleanup of laptop article
Date: Fri, 23 May 2003 19:11:57 +0200

 On Thu, May 22, 2003 at 01:45:04AM +0200, Simon L.Nielsen wrote:
 > General cleanup of the laptop article :
 > 
 > * Add id attributes to all sect1 tags
 
 This is far to be mandatory on a so little article.
 
 > * s/FreeBSD/&os;/g
 
 This tag should be used on new submission, but a full commit does not
 worth since it brings nothing new to the reader.
 
 > * Add application tags around XFree86 references
 > * Minor markup cleanups... Hope they right
 > * Refer to more files/programs using manual page references
 > * Remove some redundant words/sentences (inspired by FDP Writing style section)
 > 
 > Note: This article is in need of a whitespace cleanup.
 > >How-To-Repeat:
 > >Fix:
 > --- doc-article-laptop-cleanup.patch begins here ---
 [...]
 >  
 > -    <programlisting>
 > -      Option "Emulate3Buttons"
 > -    </programlisting>
 > +    <programlisting>Option "Emulate3Buttons"</programlisting>
 
 It's not good: no whitespace/wrapline change with content change.
 And this one is quite useless.
 
 [...]
 > -      cards is in the file <filename>/etc/defaults/pccard.conf</filename>.  
 > +      cards is in &man.pccard.conf.5;.
 
 /etc/defaults/pccard.conf is always up to date, it's not the case of the
 manual page.
 
 >        Look through it, and preferably buy cards listed there.  Cards not
 >        listed may also work as <quote>generic</quote> devices: in 
 >        particular most modems (16-bit) should work fine, provided they 
 > @@ -128,39 +126,38 @@
 >        card, remove irq 5 (otherwise you may experience hangs when you 
 >        insert a card).  Check also the available memory slots; if your 
 >        card is not being detected, try changing it to one of the other 
 > -      allowed values (listed in the manual page &man.pccardc.8;).
 > +      allowed values (listed in &man.pccardc.8;).
 
 manual page was good there.
 
 >      </para>
 >  
 > -    <para>If it is not running already, start the <command>pccardd</command> daemon.
 > +    <para>If it is not running already, start the &man.pccardd.8; daemon.
 >        (To enable it at boot time, add
 >        <programlisting>pccard_enable="YES"</programlisting> to
 > -      <filename>/etc/rc.conf</filename>.)  Now your cards should be
 > +      &man.rc.conf.5;).  Now your cards should be
 
 Well /etc/rc.conf is a better choice there, for obvious reason.
 
 >        detected when you insert and remove them, and you should get
 >        log messages about new devices being enabled.</para>
 >  
 >      <para>There have been major changes to the pccard code
 >        (including ISA routing of interrupts, for machines whose
 > -      PCI BIOS FreeBSD can not seem to use) before the FreeBSD 4.4
 > +      PCI BIOS &os; can not seem to use) before the &os; 4.4
 >        release.  If you have problems, try upgrading your system.</para>
 >   
 >    </sect1> 
 >  
 > -  <sect1> 
 > +  <sect1 id="power-management">
 >  
 >      <title>Power management</title>
 >  
 >      <para>Unfortunately, this is not very reliably supported under
 > -      FreeBSD.  If you are lucky, some functions may work reliably;
 > +      &os;.  If you are lucky, some functions may work reliably;
 >        or they may not work at all.</para>
 >  
 >      <para>To enable this, you may need to compile a kernel with
 >        power management support (<literal>device apm0</literal>) or
 >        add the option <literal>enable apm0</literal> to 
 > -      <filename>/boot/loader.conf</filename>, and
 > -      also enable the apm daemon at boot time (line
 > +      &man.loader.conf.5;, and
 > +      also enable the &man.apm.8; daemon at boot time (line
 
 /boot/loader.conf is not bad here, and &man.apmd.8; seems better.
 
 Marc