Skip site navigation (1)Skip section navigation (2)
Date:      Sun, 13 Jun 1999 08:00:03 -0700 (PDT)
From:      Chris Costello <chris@calldei.com>
To:        freebsd-doc@freebsd.org
Subject:   Re: docs/12181: [Patch] doc/en/handbook/kernelconfig/chapter.sgml needs updating.
Message-ID:  <199906131500.IAA79282@freefall.freebsd.org>

next in thread | raw e-mail | index | archive | help
The following reply was made to PR docs/12181; it has been noted by GNATS.

From: Chris Costello <chris@calldei.com>
To: FreeBSD-gnats-submit@FreeBSD.ORG
Cc:  
Subject: Re: docs/12181: [Patch] doc/en/handbook/kernelconfig/chapter.sgml needs updating.
Date: Sun, 13 Jun 1999 09:52:25 -0500

 On Sat, Jun 12, 1999, chris@calldei.com wrote:
 > >Number:         12181
 > >Category:       docs
 > >Synopsis:       [Patch] doc/en/handbook/kernelconfig/chapter.sgml needs updating.
 > >Confidential:   no
 > >Severity:       serious
 > >Priority:       medium
 > >Responsible:    freebsd-doc
 > >State:          open
 
 > 
 > $Id: chapter.sgml,v 1.16 1999/05/28 00:31:25 dwhite Exp $
 > 
 > >Description:
 > 
 > Modified kernel config sample lines to remove the quotes.
 > Fix where I probably put 'i386' instead of <replaceable>arch</replaceable>
 > Remove warning note about quote characters.
 
 Also, change <literal>GENERIC</literal> to
 <filename>GENERIC</filename.  Add <filename></filename> around
 'GENERIC' where necessary.
 
 > 
 > >How-To-Repeat:
 > 
 > View the relevant section of the handbook.
 > 
 > >Fix:
 
    I missed a couple things.  The following fix should be used:
 
 Index: chapter.sgml
 ===================================================================
 RCS file: /home/ncvs/doc/en/handbook/kernelconfig/chapter.sgml,v
 retrieving revision 1.16
 diff -u -r1.16 chapter.sgml
 --- chapter.sgml	1999/05/28 00:31:25	1.16
 +++ chapter.sgml	1999/06/13 14:49:51
 @@ -21,7 +21,7 @@
      <para>Building a custom kernel is one of the most important rites of
        passage every Unix system administrator must endure.  This process,
        while time-consuming, will provide many benefits to your FreeBSD system.
 -      Unlike the <literal>GENERIC</literal> kernel, which must support every
 +      Unlike the <filename>GENERIC</filename> kernel, which must support every
        possible SCSI and network card, along with tons of other rarely used
        hardware support, a custom kernel only contains support for
        <emphasis>your</emphasis> PC's hardware.  This has a number of
 @@ -46,7 +46,8 @@
  	<para>Finally, there are several kernel options which you can tune to
  	  fit your needs, and device driver support for things like sound
  	  cards which you can include in your kernel but are
 -	  <emphasis>not</emphasis> present in the GENERIC kernel.</para>
 +	  <emphasis>not</emphasis> present in the <filename>GENERIC</filename>
 +	   kernel.</para>
        </listitem>
      </itemizedlist>
    </sect1>
 @@ -195,7 +196,7 @@
        
        <variablelist>
  	<varlistentry>
 -	  <term><literal>machine "i386"</literal></term>
 +	  <term><literal>machine <replaceable>arch</replaceable></literal></term>
  	  
  	  <listitem>
  	    <para>The first keyword is <literal>machine</literal>, which,
 @@ -203,20 +204,12 @@
  	      DEC Alpha processors, will be either 
  	      <replaceable>i386</replaceable> or 
  	      <replaceable>alpha</replaceable>.</para>
 -
 -	    <note>
 -	      <para>Any keyword which contains numbers used as text must be
 -		enclosed in quotation marks, otherwise
 -		<command>config</command> gets confused and thinks you mean
 -		the actual number 386 if you enter 
 -		<literal>machine i386</literal>.</para>
 -	    </note>
  	  </listitem>
  	</varlistentry>
  	
  	<varlistentry>
  	  <term><literal>cpu
 -	      "<replaceable>cpu_type</replaceable>"</literal></term>
 +	      <replaceable>cpu_type</replaceable></literal></term>
  	  
  	  <listitem>
  	    <para>The next keyword is <literal>cpu</literal>, which includes
 @@ -382,7 +375,7 @@
  	</varlistentry>
  	
  	<varlistentry>
 -	  <term><literal>options "COMPAT_43"</literal></term>
 +	  <term><literal>options COMPAT_43</literal></term>
  	  
  	  <listitem>
  	    <para>Compatibility with 4.3BSD.  Leave this in; some programs
 @@ -501,7 +494,7 @@
  	</varlistentry>
  	
  	<varlistentry>
 -	  <term><literal>options "CD9660"</literal></term>
 +	  <term><literal>options CD9660</literal></term>
  	  
  	  <listitem>
  	    <para>ISO 9660 filesystem for CD-ROMs.  Comment it out if you do
 @@ -557,7 +550,7 @@
  	</varlistentry>
  	
  	<varlistentry>
 -	  <term><literal>options "EXT2FS"</literal></term>
 +	  <term><literal>options EXT2FS</literal></term>
  	  
  	  <listitem>
  	    <para>Linux's native file system.  With ext2fs support you are
 @@ -656,7 +649,7 @@
  	</varlistentry>
  	
  	<varlistentry>
 -	  <term><literal>device npx0 at isa? port "IO_NPX" irq 13
 +	  <term><literal>device npx0 at isa? port IO_NPX irq 13
  	      vector npxintr</literal></term>
  	  
  	  <listitem>
 @@ -740,7 +733,7 @@
  	    
  	    <variablelist>
  	      <varlistentry>
 -		<term><literal>controller bt0 at isa? port "IO_BT0" bio irq ?
 +		<term><literal>controller bt0 at isa? port IO_BT0 bio irq ?
  		    vector btintr</literal></term>
  		
  		<listitem>
 @@ -749,7 +742,7 @@
  	      </varlistentry>
  	      
  	      <varlistentry>
 -		<term><literal>controller uha0 at isa? port "IO_UHA0" bio irq
 +		<term><literal>controller uha0 at isa? port IO_UHA0 bio irq
  		    ? drq 5 vector uhaintr</literal></term>
  		
  		<listitem>
 @@ -775,7 +768,7 @@
  	      </varlistentry>
  	      
  	      <varlistentry>
 -		<term><literal>controller aha0    at isa? port "IO_AHA0" bio
 +		<term><literal>controller aha0    at isa? port IO_AHA0 bio
  		    irq ? drq 5 vector ahaintr</literal></term>
  		
  		<listitem>
 @@ -906,7 +899,7 @@
  	  
        <variablelist>
  	<varlistentry>
 -	  <term><literal>device sc0 at isa? port "IO_KBD" tty irq 1 vector
 +	  <term><literal>device sc0 at isa? port IO_KBD tty irq 1 vector
  	      scintr</literal></term>
  	  
  	  <listitem>
 @@ -936,8 +929,8 @@
  	    <variablelist>
  	      <varlistentry>
  		<term><literal>options 
 -		  "KBD_RESETDELAY=<replaceable>X</replaceable>", options 
 -		  "KBD_MAXWAIT=<replaceable>Y</replaceable>"</literal></term>
 +		  KBD_RESETDELAY=<replaceable>X</replaceable>, options 
 +		  KBD_MAXWAIT=<replaceable>Y</replaceable></literal></term>
  
  		<listitem>
  		  <para>The keyboard driver <literal>atkbd</literal> and the
 @@ -958,7 +951,7 @@
  
  	      <varlistentry>
  		<term><literal>options 
 -		  "KBDIO_DEBUG=<replaceable>N</replaceable>"</literal></term>
 +		  KBDIO_DEBUG=<replaceable>N</replaceable></literal></term>
  
  		<listitem>
  		  <para>Sets the debug level to <replaceable>N</replaceable>.
 @@ -989,7 +982,7 @@
  	</varlistentry>
  
  	<varlistentry>
 -	  <term><literal>device vt0 at isa? port "IO_KBD" tty irq 1 vector
 +	  <term><literal>device vt0 at isa? port IO_KBD tty irq 1 vector
  	      pcrint</literal></term>
  	  
  	  <listitem>
 @@ -1007,7 +1000,7 @@
  		  
  	    <variablelist>
  	      <varlistentry>
 -		<term><literal>options "PCVT_FREEBSD=210"</literal></term>
 +		<term><literal>options PCVT_FREEBSD=210</literal></term>
  		
  		<listitem>
  		  <para>Required with the <literal>vt0</literal> console
 @@ -1047,7 +1040,7 @@
  	</varlistentry>
  	
  	<varlistentry>
 -	  <term><literal>device psm0 at isa? port "IO_KBD" conflicts tty irq
 +	  <term><literal>device psm0 at isa? port IO_KBD conflicts tty irq
  	      12 vector psmintr</literal></term>
  	  
  	  <listitem>
 @@ -1069,7 +1062,7 @@
  	  
        <variablelist>
  	<varlistentry>
 -	  <term><literal>device sio0 at isa? port "IO_COM1" tty irq 4 vector
 +	  <term><literal>device sio0 at isa? port IO_COM1 tty irq 4 vector
  	      siointr</literal><anchor
  	      id="kernelconfig-serial"></term>
  	  
 @@ -1403,9 +1396,10 @@
  	  <title>Sound cards</title>
        
        <para>This is the first section containing lines that are not in the
 -	GENERIC kernel.  To include sound card support, you will have to copy
 -	the appropriate lines from the LINT kernel (which contains support for
 -	<emphasis>every</emphasis> device) as follows:</para>
 +	<filename>GENERIC</filename> kernel.  To include sound card support,
 +	you will have to copy the appropriate lines from the LINT kernel
 +	(which contains support for <emphasis>every</emphasis> device) as
 +	follows:</para>
  	  
        
        <variablelist>
 @@ -1508,7 +1502,7 @@
  	
  	<varlistentry>
  	  <term><literal>device uart0 at isa? port 0x330 irq 5 vector
 -	      "m6850intr"</literal></term>
 +	      m6850intr</literal></term>
  	  
  	  <listitem>
  	    <para>Stand-alone 6850 UART for MIDI.</para>
 @@ -1516,7 +1510,7 @@
  	</varlistentry>
  	
  	<varlistentry>
 -	  <term><literal>device pca0 at isa? port "IO_TIMER1"
 +	  <term><literal>device pca0 at isa? port IO_TIMER1
  	      tty</literal><anchor id="kernelconfig-pcaudio"></term>
  	  
  	  <listitem>
 @@ -1654,7 +1648,7 @@
        
        <variablelist>
  	<varlistentry>
 -	  <term><literal>device joy0 at isa? port "IO_GAME"</literal></term>
 +	  <term><literal>device joy0 at isa? port IO_GAME</literal></term>
  
  	  <listitem>
  	    <para>PC joystick device.</para>
 
 -- 
 Chris Costello                                <chris@calldei.com>
 Revolutionary:  Disk drives go round and round.
 


To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?199906131500.IAA79282>