[src/trunk]: src/share/doc/smm/config New sentence, new line.

[dholland <dholland%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/fb02b14163a3
branches:  trunk
changeset: 330354:fb02b14163a3
user:      dholland <dholland%NetBSD.org@localhost>
date:      Sun Jul 06 05:32:30 2014 +0000

description:
New sentence, new line.

diffstat:

 share/doc/smm/config/0.t |    5 +-
 share/doc/smm/config/1.t |    8 ++-
 share/doc/smm/config/2.t |   65 ++++++++++++++++++---------
 share/doc/smm/config/3.t |  110 +++++++++++++++++++++++++++++++---------------
 share/doc/smm/config/4.t |  110 +++++++++++++++++++++++++++++++---------------
 share/doc/smm/config/5.t |   74 ++++++++++++++++++++----------
 share/doc/smm/config/6.t |   50 ++++++++++++++-------
 share/doc/smm/config/a.t |   11 ++-
 share/doc/smm/config/b.t |   35 +++++++++-----
 share/doc/smm/config/d.t |   68 +++++++++++++++++++---------
 10 files changed, 354 insertions(+), 182 deletions(-)

diffs (truncated from 1291 to 300 lines):

diff -r edab5a92d763 -r fb02b14163a3 share/doc/smm/config/0.t
--- a/share/doc/smm/config/0.t  Sun Jul 06 05:31:02 2014 +0000
+++ b/share/doc/smm/config/0.t  Sun Jul 06 05:32:30 2014 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: 0.t,v 1.2 2014/07/06 05:16:18 dholland Exp $
+.\" $NetBSD: 0.t,v 1.3 2014/07/06 05:32:30 dholland Exp $
 .\" Copyright (c) 1983, 1993
 .\"    The Regents of the University of California.  All rights reserved.
 .\"
@@ -76,7 +76,8 @@
 systems with non-standard hardware configurations.
 Sections describing the preferred way to
 add new code to the system and how the system's autoconfiguration
-process operates are included.  An appendix
+process operates are included.
+An appendix
 contains a summary of the rules used by the system
 in calculating the size of system data structures,
 and also indicates some of the standard system size
diff -r edab5a92d763 -r fb02b14163a3 share/doc/smm/config/1.t
--- a/share/doc/smm/config/1.t  Sun Jul 06 05:31:02 2014 +0000
+++ b/share/doc/smm/config/1.t  Sun Jul 06 05:32:30 2014 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: 1.t,v 1.2 2014/07/06 05:16:18 dholland Exp $
+.\" $NetBSD: 1.t,v 1.3 2014/07/06 05:32:30 dholland Exp $
 .\" Copyright (c) 1983, 1993
 .\"    The Regents of the University of California.  All rights reserved.
 .\"
@@ -51,12 +51,14 @@
 This document describes the content and 
 format of system configuration
 files and the rules which must be followed when creating 
-these files.  Example configuration files are constructed
+these files.
+Example configuration files are constructed
 and discussed.
 .PP
 Later sections suggest guidelines to be used in modifying
 system source and explain some of the inner workings of the
-autoconfiguration process.  Appendix D summarizes the rules
+autoconfiguration process.
+Appendix D summarizes the rules
 used in calculating the most important system data structures
 and indicates some inherent system data structure size
 limitations (and how to go about modifying them).
diff -r edab5a92d763 -r fb02b14163a3 share/doc/smm/config/2.t
--- a/share/doc/smm/config/2.t  Sun Jul 06 05:31:02 2014 +0000
+++ b/share/doc/smm/config/2.t  Sun Jul 06 05:32:30 2014 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: 2.t,v 1.2 2014/07/06 05:16:18 dholland Exp $
+.\" $NetBSD: 2.t,v 1.3 2014/07/06 05:32:30 dholland Exp $
 .\" Copyright (c) 1983, 1993
 .\"    The Regents of the University of California.  All rights reserved.
 .\"
@@ -56,7 +56,8 @@
 .PP
 .I Config
 allows multiple system images to be generated from a single
-configuration description.  Each system image is configured
+configuration description.
+Each system image is configured
 for identical hardware, but may have different locations for the root
 file system and, possibly, other system devices.
 .NH 2
@@ -69,7 +70,8 @@
 \(dg DEC, VAX, UNIBUS, MASSBUS and MicroVAX are trademarks of Digital
 Equipment Corporation.
 .FE
-or some other machine on which NetBSD operates.  The machine type
+or some other machine on which NetBSD operates.
+The machine type
 is used to locate certain data files which are machine specific, and
 also to select rules used in constructing the resultant
 configuration files.
@@ -85,7 +87,8 @@
 the cpu designation for compatible machines introduced earlier.)
 Specifying
 more than one cpu type implies that the system should be configured to run
-on any of the cpu's specified.  For some types of machines this is not
+on any of the cpu's specified.
+For some types of machines this is not
 possible and 
 .I config
 will print a diagnostic indicating such.
@@ -95,11 +98,15 @@
 The
 .I "system identification"
 is a moniker attached to the system, and often the machine on which the
-system is to run.  For example, at Berkeley we have machines named Ernie
-(Co-VAX), Kim (No-VAX), and so on.  The system identifier selected is used to
+system is to run.
+For example, at Berkeley we have machines named Ernie
+(Co-VAX), Kim (No-VAX), and so on.
+The system identifier selected is used to
 create a global C ``#define'' which may be used to isolate system dependent
-pieces of code in the kernel.  For example, Ernie's Varian driver used
-to be special cased because its interrupt vectors were wired together.  The
+pieces of code in the kernel.
+For example, Ernie's Varian driver used
+to be special cased because its interrupt vectors were wired together.
+The
 code in the driver which understood how to handle this non-standard hardware
 configuration was conditionally compiled in only if the system
 was for Ernie.  
@@ -112,8 +119,10 @@
 .PP
 The timezone in which the system is to run is used to define the
 information returned by the \fIgettimeofday\fP\|(2)
-system call.  This value is specified as the number of hours east
-or west of GMT.  Negative numbers indicate a value east of GMT.
+system call.
+This value is specified as the number of hours east
+or west of GMT.
+Negative numbers indicate a value east of GMT.
 The timezone specification may also indicate the
 type of daylight savings time rules to be applied.
 .NH 2
@@ -122,7 +131,8 @@
 The system allocates many system data structures at boot time
 based on the maximum number of users the system will support.
 This number is normally between 8 and 40, depending
-on the hardware and expected job mix.  The rules
+on the hardware and expected job mix.
+The rules
 used to calculate system data structures are discussed in
 Appendix D.
 .NH 2
@@ -130,7 +140,8 @@
 .PP
 When the system boots it must know the location of
 the root of the file system
-tree.  This location and the part(s) of the disk(s) to be used
+tree.
+This location and the part(s) of the disk(s) to be used
 for paging and swapping must be specified in order to create
 a complete configuration description.  
 .I Config
@@ -138,20 +149,25 @@
 these are described in Appendix B.
 .PP
 When a generic system is configured, the root file system is left
-undefined until the system is booted.  In this case, the root file
+undefined until the system is booted.
+In this case, the root file
 system need not be specified, only that the system is a generic system.
 .NH 2
 Hardware devices
 .PP
 When the system boots it goes through an
 .I autoconfiguration
-phase.  During this period, the system searches for all
+phase.
+During this period, the system searches for all
 those hardware devices
-which the system builder has indicated might be present.  This probing
+which the system builder has indicated might be present.
+This probing
 sequence requires certain pieces of information such as register
-addresses, bus interconnects, etc.  A system's hardware may be configured
+addresses, bus interconnects, etc.
+A system's hardware may be configured
 in a very flexible manner or be specified without any flexibility
-whatsoever.  Most people do not configure hardware devices into the
+whatsoever.
+Most people do not configure hardware devices into the
 system unless they are currently present on the machine, expect
 them to be present in the near future, or are simply guarding
 against a hardware
@@ -160,8 +176,10 @@
 has hardware problems).
 .PP
 The specification of hardware devices usually occupies the majority of
-the configuration file.  As such, a large portion of this document will
-be spent understanding it.  Section 6.3 contains a description of
+the configuration file.
+As such, a large portion of this document will
+be spent understanding it.
+Section 6.3 contains a description of
 the autoconfiguration process, as it applies to those planning to
 write, or modify existing, device drivers.
 .NH 2
@@ -180,10 +198,13 @@
 is also possible to include various optional system facilities
 or to modify system behavior and/or limits.
 For example, NetBSD can be configured to support binary compatibility for
-programs built under Linux and FreeBSD.  Also, optional support is provided
+programs built under Linux and FreeBSD.
+Also, optional support is provided
 for disk quotas and tracing the performance of the virtual memory
-subsystem.  Any optional facilities to be configured into
-the system are specified in the configuration file.  The resultant
+subsystem.
+Any optional facilities to be configured into
+the system are specified in the configuration file.
+The resultant
 files generated by
 .I config
 will automatically include the necessary pieces of the system.
diff -r edab5a92d763 -r fb02b14163a3 share/doc/smm/config/3.t
--- a/share/doc/smm/config/3.t  Sun Jul 06 05:31:02 2014 +0000
+++ b/share/doc/smm/config/3.t  Sun Jul 06 05:32:30 2014 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: 3.t,v 1.2 2014/07/06 05:16:18 dholland Exp $
+.\" $NetBSD: 3.t,v 1.3 2014/07/06 05:32:30 dholland Exp $
 .\" Copyright (c) 1983, 1993
 .\"    The Regents of the University of California.  All rights reserved.
 .\"
@@ -38,7 +38,8 @@
 SYSTEM BUILDING PROCESS
 .PP
 In this section we consider the steps necessary to build a bootable system
-image.  We assume the system source is located in the ``/usr/src'' directory
+image.
+We assume the system source is located in the ``/usr/src'' directory
 and that, initially, the system is being configured from source code.
 .PP
 Under normal circumstances there are 5 steps in building a system.
@@ -61,11 +62,13 @@
 Compile and link the system with 
 .IR make .
 .PP
-Steps 1 and 2 are usually done only once.  When a system configuration
+Steps 1 and 2 are usually done only once.
+When a system configuration
 changes it usually suffices to just run
 .I config
 on the modified configuration file, rebuild the source code dependencies,
-and remake the system.  Sometimes,
+and remake the system.
+Sometimes,
 however, configuration dependencies may not be noticed in which case
 it is necessary to clean out the object files saved
 in the system's directory; this will be discussed later.
@@ -78,9 +81,11 @@
 (For example, configuration files for 64-bit x86 machines live in
 ``/usr/src/sys/arch/amd64/conf''.)
 A configuration file is most easily constructed by copying an
-existing configuration file and modifying it.  The NetBSD distribution
+existing configuration file and modifying it.
+The NetBSD distribution
 contains assorted standard configuration files for different machine
-types and varieties.  Start with ``GENERIC'' if no other is more
+types and varieties.
+Start with ``GENERIC'' if no other is more
 appropriate.
 .PP
 The configuration file must have the same name as the directory in
@@ -89,7 +94,8 @@
 .I config
 assumes this directory is located under the ``compile'' directory at
 the same level as the ``conf'' directory in which  it
-is run.  For example, the generic 64-bit x86
+is run.
+For example, the generic 64-bit x86
 system has a configuration file ``/usr/src/sys/arch/amd64/conf/GENERIC''
 and an accompanying
 directory named ``/usr/src/sys/arch/amd64/compile/GENERIC''.
@@ -101,35 +107,43 @@
 use pathnames of the form ``../''.
 .PP
 When building the configuration file, be sure to include the items
-described in section 2.  In particular, the machine type,
+described in section 2.
+In particular, the machine type,
 cpu type, timezone, system identifier, maximum users, and root device
-must be specified.  The specification of the hardware present may take
+must be specified.
+The specification of the hardware present may take
 a bit of work; particularly if your hardware is configured at non-standard
 places (e.g. device registers located at funny places or devices not
-supported by the system).  Section 4 of this document
+supported by the system).
+Section 4 of this document
 gives a detailed description of the configuration file syntax,
 section 5 explains some sample configuration files, and
 section 6 discusses how to add new devices to
-the system.  If the devices to be configured are not already
+the system.
+If the devices to be configured are not already
 described in one of the existing configuration files you should check
-the section 4 manual pages.  For each
+the section 4 manual pages.
+For each
 supported device, the manual page synopsis entry gives a
 sample configuration line.
 .PP
 Once the configuration file is complete, run it through
 .I config
-and look for any errors.  Never try and use a system which
+and look for any errors.
+Never try and use a system which
 .I config
 has complained about; the results are unpredictable.
 For the most part,
 .IR config 's
-error diagnostics are self explanatory.  It may be the case that
+error diagnostics are self explanatory.
+It may be the case that
 the line numbers given with the error messages are off by one.
 .PP