Bug 39824

Summary: Various tweaks for doc/en_US.ISO8859-1/books/handbook/kernelconfig/chapter.sgml; corresponding comment clarification for GENERIC
Product: Documentation Reporter: Chris Pepper <pepper>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
chapter.sgml.diff
none
file.diff none

Description Chris Pepper 2002-06-25 04:50:01 UTC
	Misc linguistic tweaks.
	Clarify description of /usr/src/UPDATING 
	Change  <quote>traditional</quote> adjective for kernel builds to old; change <quote>new</quote> to new.
	Change "The Configuration File" to "The Kernel Configuration File" (it's not the only config file!).
	procfs is a real filesystem, that doesn't hold actual on-disk data files.
	Mention that ptys are used for ssh.

	The vpo option's comment in GENERIC should mention it's for Zip drives; this patch includes both a patch to the quoted line for chapter.sgml, and a patch for GENERIC as well.

Fix: Two patches follow.
How-To-Repeat: 	Read doc/en_US.ISO8859-1/books/handbook/kernelconfig/chapter.sgml & /usr/src/sys/i386/conf/GENERIC.
Comment 1 Chris Pepper 2002-06-25 05:12:51 UTC
	Some additional comments on this chapter:

>If you have not upgraded your source tree in any way (you have not 
>run CVSup, CTM, or used anoncvs), then you should use the config, 
>make depend, make, make install sequence.

	This paragraph appears to assume that should use the old 
kernel build procedure, rather than the new procedure. I'm not sure 
what the equivalent is for the new style, or if this para serves any 
purpose (after the earlier section explaining when to use old vs. new 
procedures).


>This line allows the kernel to simulate a math co-processor if your 
>computer does not have one (386 or 486SX). If you have a 486DX, or a 
>386 or 486SX (with a separate 387 or 487 chip), or higher (Pentium, 
>Pentium II, etc.), you can comment this line out.

	It would be worth mentioning whether or not a Celeron 
includes an FPU here, since many people know Celerons are somehow 
less capable (cache) than a real Pentium, but not the details, or 
that they can check the Features line in dmesg.


>     options          MSDOSFS      #MSDOS Filesystem
>
>
>The MS-DOS filesystem. Unless you plan to mount a DOS formatted hard 
>drive partition at boot time, you can safely comment this out. It 
>will be automatically loaded the first time you mount a DOS 
>partition, as described above. Also, the excellent mtools software 
>(in the ports collection) allows you to access DOS floppies without 
>having to mount and unmount them (and does not require MSDOSFS at 
>all).
>
>
>     options          CD9660       #ISO 9660 Filesystem
>     options          CD9660_ROOT  #CD-ROM usable as root, CD9660 required
>
>
>The ISO 9660 filesystem for CDROMs. Comment it out if you do not 
>have a CDROM drive or only mount data CDs occasionally (since it 
>will be dynamically loaded the first time you mount a data CD). 
>Audio CDs do not need this filesystem.

	Unclear -- I *think* these paras mean if the fs need not be 
built into the kernel, because modules are loaded as necessary, but 
this is confusing.


>If you have not upgraded your source tree in any way (you have not 
>run CVSup, CTM, or used anoncvs), then you should use the config, 
>make depend, make, make install sequence.

	This paragraph appears to assume that should use the old 
kernel build procedure, rather than the new procedure. I'm not sure 
what the equivalent is for the new style, or if this para serves any 
purpose (after the earlier section explaining when to use old vs. new 
procedures).


						Chris Pepper
-- 
Chris Pepper:               <http://www.reppep.com/~pepper/>
Rockefeller University:        <http://www.rockefeller.edu/>
Comment 2 Giorgos Keramidas freebsd_committer freebsd_triage 2002-07-03 01:11:36 UTC
On 2002-06-24 23:45 +0000, Chris Pepper wrote:
> Index: chapter.sgml
> ===================================================================
> RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/handbook/kernelconfig/chapter.sgml,v
> retrieving revision 1.76

See comments inline.  I have refrained from commenting on large parts
of this patch.  Where there have not been any comments appended to the
patch text, you may safely assume my approval.  So, here it is:

> @@ -120,7 +120,7 @@
>  
>        <listitem>
>  	<para>Additional hardware support.  A custom kernel allows you to
> -	  add in support for devices such as sound cards, which are not
> +	  add in support for devices such as sound cards which are not
>  	  present in the <literal>GENERIC</literal> kernel.</para>
>        </listitem>
>      </itemizedlist>

Actually, wouldn't this be more correct by converting the "such as..."
part in a parenthetical expression of some sort & enclosing it in commas?

	      <para>Additional hardware support.  A custom kernel allows you to
	-       add in support for devices such as sound cards, which are not
	+       add in support for devices, such as sound cards, which are not

In this version, "which" clearly refers to "devices".
What do you think?

> +      <para>If you <link linkend="cutting-edge">update your FreeBSD source</link>, be sure to check the file
> +        <filename>/usr/src/UPDATING</filename>.
> +        This file mentions important issues you should be aware of when working with updated FreeBSD source code.  <filename>/usr/src/UPDATING</filename> always tracks
> +        your version of the FreeBSD source, and is therefore more up to date
> +        for your system than the handbook.</para>

Apart from a few terrible wrapping issues,
the new text looks great :)

>        if you have them enabled.  If you do not see the soft-updates option then
> -      you will need to activate it using the &man.tunefs.8; or &man.newfs.8;
> +      you may activate it using &man.tunefs.8; or &man.newfs.8;
>        for new filesystems.</para>

Hmmm, softupdates can be activated for existing filesystems too.  I
recently helped a guy on IRC to hack his /etc/rc script and enable
softupdates for all his filesystems, while logged in through ssh to a
collocated FreeBSD machine.  This part needs a bit more clarification.

>      <para>Allow users to grab the console, which is useful for X users.
>        For example, you can create a console xterm by typing <command>xterm
>        -C</command>, which will display any <command>write</command>,
> -      <command>talk</command>, and any other messages you receive, as well
> +      <command>talk</command>, and other messages you receive, as well
>        as any console messages sent by the kernel.</para>

Not sure if this is an improvement.
"foo ... and bar, as well as baz" looks funny.

>  	values for these lines.  Some video cards (notably those based on
> -	S3 chips) use IO addresses in the form of
> +	S3 chipsets) use IO addresses in the form of

Well, this change seems a bit gratuitous.  But I'll let the majority
of the freebsd-doc English speaking people decide :)

> -    <para>This is the ISA-bus parallel port interface.</para>
> +    <para>This is the ISA bus parallel port interface.</para>

is this really necessary too?

>  Some additional comments on this chapter:
>
>  >If you have not upgraded your source tree in any way (you have not
>  >run CVSup, CTM, or used anoncvs), then you should use the config,
>  >make depend, make, make install sequence.
>
>  This paragraph appears to assume that should use the old kernel
>  build procedure, rather than the new procedure. I'm not sure what
>  the equivalent is for the new style, or if this para serves any
>  purpose (after the earlier section explaining when to use old vs.
>  new procedures).

No.  It means exactly what it says.  Although it needs a bit more
detail.  If you haven't CVSup'ed your sources, and you still have the
/usr/obj files from your last kernel build around, you can safely use
the old way to change kernel options.  If the old /usr/obj files are
around and you do NOT ommit the 'depend' step, but DO ommit the
'clean' step, you may save some cycles by avoiding a full kernel
compile.  Only the affected parts of the kernel should be rebuilt.

- Giorgos
Comment 3 Tom Rhodes freebsd_committer freebsd_triage 2006-05-15 21:15:02 UTC
State Changed
From-To: open->closed

Closed, mostly merged information.