Date: Sat, 16 Apr 2005 13:02:25 +0200 From: Joel Dahl <joel@automatvapen.se> To: freebsd-doc@freebsd.org Subject: [patch] Update section 8.4 in the handbook Message-ID: <1113649345.509.26.camel@dude.automatvapen.se>
next in thread | raw e-mail | index | archive | help
--=-/qS15RQrPQWjx3YxCJIi
Content-Type: text/plain
Content-Transfer-Encoding: 7bit
Hi All,
The attached patch contains some corrections to section 8.4 (the
configuration file) in our handbook:
o Move "device npx" and "device loop"
o Remove "maxusers n" and "#makeoptions DEBUG=-g"
o Update/Remove some comments etc.
My personal opinion is that with this patch, the whole section becomes
much more pleasant to read, since all options are sorted as they appear
in GENERIC in 5.4.
Any objections? :-)
--
Joel
--=-/qS15RQrPQWjx3YxCJIi
Content-Disposition: attachment; filename=kernelconfig2.diff
Content-Type: text/x-patch; name=kernelconfig2.diff; charset=us-ascii
Content-Transfer-Encoding: 7bit
Index: chapter.sgml
===================================================================
RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/handbook/kernelconfig/chapter.sgml,v
retrieving revision 1.156
diff -u -r1.156 chapter.sgml
--- chapter.sgml 14 Apr 2005 18:40:33 -0000 1.156
+++ chapter.sgml 16 Apr 2005 10:03:31 -0000
@@ -447,11 +447,9 @@
Each line contains a keyword and one or more arguments. For
simplicity, most lines only contain one argument. Anything
following a <literal>#</literal> is considered a comment and
- ignored. The following sections describe each keyword, generally in
- the order they are listed in <filename>GENERIC</filename>, although
- some related keywords have been grouped together in a single section
- (such as Networking) even though they are actually scattered
- throughout the <filename>GENERIC</filename> file. <anchor
+ ignored. The following sections describe each keyword in
+ the order they are listed in <filename>GENERIC</filename>.
+ <anchor
id="kernelconfig-options"> For an exhaustive list of architecture
dependent options and devices, see the <filename>NOTES</filename>
file in the same directory as <filename>GENERIC</filename>. For
@@ -496,28 +494,6 @@
<filename>/usr/src/sys/<replaceable>i386</replaceable>/conf/GENERIC</filename>
fairly closely.</para>
- <programlisting>#
-# GENERIC -- Generic kernel configuration file for &os;/i386
-#
-# For more information on this file, please read the handbook section on
-# Kernel Configuration Files:
-#
-# http://www.&os;.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig-config.html
-#
-# The handbook is also available locally in /usr/share/doc/handbook
-# if you've installed the doc distribution, otherwise always see the
-# &os; World Wide Web server (http://www.FreeBSD.org/) for the
-# latest information.
-#
-# An exhaustive list of options and more detailed explanations of the
-# device lines is also present in the ../../conf/NOTES and NOTES files.
-# If you are in doubt as to the purpose or necessity of a line, check first
-# in NOTES.
-#
-# $FreeBSD: /repoman/r/ncvs/src/sys/i386/conf/GENERIC,v 1.413 2004/08/11 01:34:18 rwatson Exp $</programlisting>
-
- <para>The following are the mandatory keywords required in
- <emphasis>every</emphasis> kernel you build:</para>
<indexterm>
<primary>kernel options</primary>
<secondary>machine</secondary>
@@ -595,80 +571,6 @@
kernel, so it is useful to give the new kernel a different name if you
want to keep it separate from your usual kernel (e.g., you want to
build an experimental kernel).</para>
- <indexterm>
- <primary>kernel options</primary>
- <secondary>maxusers</secondary>
- </indexterm>
-
- <programlisting>maxusers <replaceable>n</replaceable></programlisting>
-
- <para>The <literal>maxusers</literal> option sets the size of a number
- of important system tables. This number is supposed to be roughly
- equal to the number of simultaneous users you expect to have on your
- machine.</para>
-
- <para>Starting with &os; 4.5, the system will auto-tune this setting
- for you if you explicitly set it to <literal>0</literal><footnote>
- <para>The auto-tuning algorithm sets <literal>maxusers</literal> equal
- to the amount of memory in the system, with a minimum of 32, and a
- maximum of 384.</para></footnote>.
- In &os; 5.X and above, <literal>maxusers</literal> will default to
- <literal>0</literal> if not specified. If you are using an
- version of &os; earlier than 4.5, or you want to manage it
- yourself you will want to set
- <literal>maxusers</literal> to at least 4, especially if you are
- using the X Window System or compiling software. The reason is that
- the most important table set by <literal>maxusers</literal> is the
- maximum number of processes, which is set to <literal>20 + 16 *
- maxusers</literal>, so if you set <literal>maxusers</literal> to 1,
- then you can only have 36 simultaneous processes, including the 18
- or so that the system starts up at boot time and the 15 or so you
- will probably create when you start the X Window System. Even a
- simple task like reading a manual page will start up nine processes to
- filter, decompress, and view it. Setting
- <literal>maxusers</literal> to 64 will allow you to have up to 1044
- simultaneous processes, which should be enough for nearly all uses.
- If, however, you see the dreaded <errortype>proc table
- full</errortype> error when trying to start another program, or are
- running a server with a large number of simultaneous users (like
- <hostid role="fqdn">ftp.FreeBSD.org</hostid>), you can always
- increase the number and rebuild.</para>
-
- <note>
- <para><literal>maxusers</literal> does <emphasis>not</emphasis>
- limit the number of users which can log into your machine. It
- simply sets various table sizes to reasonable values considering
- the maximum number of users you will likely have on your system
- and how many processes each of them will be running. One keyword
- which <emphasis>does</emphasis> limit the number of simultaneous
- remote logins and X terminal windows is <link
- linkend="kernelconfig-ptys"><literal>pseudo-device pty
- 16</literal></link>. With &os; 5.X, you do not have to
- worry about this number since the &man.pty.4; driver is
- <quote>auto-cloning</quote>; you simply use the line
- <literal>device pty</literal> in your configuration file.</para>
- </note>
-
- <programlisting># Floating point support - do not disable.
-device npx</programlisting>
-
- <para><literal>npx</literal> is the interface to the floating point
- math unit in &os;, which is either the hardware co-processor or
- the software math emulator. This is <emphasis>not</emphasis>
- optional.</para>
-
- <programlisting># Pseudo devices
-device loop # Network loopback</programlisting>
-
- <para>This is the generic loopback device for TCP/IP. If you telnet
- or FTP to <hostid>localhost</hostid> (a.k.a. <hostid
- role="ipaddr">127.0.0.1</hostid>) it will come back at you through
- this device. This is <emphasis>mandatory</emphasis>. Under
- &os; 4.X you have to use the line <literal>pseudo-device
- loop</literal>.</para>
-
- <para>Everything that follows is more or less optional. See the notes
- underneath or next to each option for more information.</para>
<programlisting>#To statically compile in device wiring instead of /boot/device.hints
#hints "GENERIC.hints" # Default places to look for devices.</programlisting>
@@ -685,21 +587,6 @@
<!-- XXX: Add a comment here that explains when compiling hints into
the kernel is a good idea and why. -->
- <programlisting>#makeoptions DEBUG=-g # Build kernel with gdb(1) debug symbols</programlisting>
-
- <para>The normal build process of &os; does not include
- debugging information when building the kernel and strips most
- symbols after the resulting kernel is linked, to save some space
- at the install location. If you are going to do tests of kernels
- in the -CURRENT branch or develop changes of your own for the &os;
- kernel, you might want to uncomment this line. It will enable the
- use of the <option>-g</option> option which enables debugging
- information when passed to &man.gcc.1;. The same can be
- accomplished by the &man.config.8; <option>-g</option> option, if
- you are using the <quote>traditional</quote> way for building your
- kernels (see <xref linkend="kernelconfig-building">
- for more information).</para>
-
<programlisting>options SCHED_4BSD # 4BSD scheduler</programlisting>
<para>The traditional scheduler for &os;. Depending on your system's
@@ -1114,6 +1001,14 @@
will enable support for AGP, and AGP GART for boards which
have these features.</para>
+ <programlisting># Floating point support - do not disable.
+device npx</programlisting>
+
+ <para><literal>npx</literal> is the interface to the floating point
+ math unit in &os;, which is either the hardware co-processor or
+ the software math emulator. This is <emphasis>not</emphasis>
+ optional.</para>
+
<indexterm>
<primary>APM</primary>
</indexterm>
@@ -1282,6 +1177,16 @@
<para>Support for various wireless cards.</para>
+ <programlisting># Pseudo devices
+device loop # Network loopback</programlisting>
+
+ <para>This is the generic loopback device for TCP/IP. If you telnet
+ or FTP to <hostid>localhost</hostid> (a.k.a. <hostid
+ role="ipaddr">127.0.0.1</hostid>) it will come back at you through
+ this device. This is <emphasis>mandatory</emphasis>. Under
+ &os; 4.X you have to use the line <literal>pseudo-device
+ loop</literal>.</para>
+
<programlisting>device mem # Memory and kernel memory devices</programlisting>
<para>The system memory devices.</para>
--=-/qS15RQrPQWjx3YxCJIi--
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?1113649345.509.26.camel>