A few proposed changes for some case consistency, paragraph and list spacing, improved readability, man page/web page references, consistent directory name formatting (no trailing "/"), consistent use of colons, and the removal of some trailing whitespace.
Regards, Index: faq5.html =================================================================== RCS file: /cvs/www/faq/faq5.html,v retrieving revision 1.214 diff -u -p -r1.214 faq5.html --- faq5.html 25 Aug 2015 15:00:17 -0000 1.214 +++ faq5.html 7 Sep 2015 01:32:07 -0000 @@ -120,7 +120,7 @@ and is a branch from the main developmen When very important fixes are made to <i>-current</i>, they are "back ported" (merged) into the <i>-stable</i> branches; because of this, <i>-stable</i> is also known as the -"<i>patch branch</i>." +"<i>Patch branch</i>." In the above illustration, the vertical dotted lines denote bug fixes being incorporated into the <i>-stable</i> branches. You will also note that in the above example, the <i>5.4-stable</i> branch came @@ -228,7 +228,7 @@ When upgrading, you will typically have <a href="upgrade57.html">Upgrade guide</a> (when changing releases) to make the changes required to run the upgraded version of OpenBSD. -<br> +<p> <b>Updating</b> is the process of applying patches to a system to improve the operation WITHOUT changing the basic functionality or binary compatibility. @@ -399,9 +399,9 @@ you may find it worth having a local CVS using CVSync or rsync. <p> -After deciding which <a href="../anoncvs.html">AnonCVS server</a> you -wish to use, you must "checkout" the source tree, after that, you then -maintain the tree by running "updates", to pull updated files to your +After deciding which <a href="../anoncvs.html">AnonCVS</a> server you +wish to use, you must "checkout" the source tree, and then +maintain the tree by running "updates" to pull updated files to your local tree. <p> @@ -415,7 +415,7 @@ Following and understanding directions h <p> <b>Following <i>-current</i></b><br> <blockquote> -In this case, we will assume we are using a public AnonCVS +In this case, we will assume we are using a public <a href="../anoncvs.html">AnonCVS</a> server, <b>anon...@anoncvs.example.org:/cvs</b>. We will also assume you are using <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=sh&sektion=1";>sh(1)</a> @@ -441,7 +441,7 @@ Once you have a tree, you can update it </blockquote> <!-- XXXrelease --> -<b>Following <i>-Stable</i></b><br> +<b>Following <i>-stable</i></b><br> <blockquote> If you wish to check out an alternative "branch" of the tree, such as the <i>-stable</i> branch, you will use the "<tt>-r</tt>" modifier to @@ -463,8 +463,8 @@ You would update the code similarly: Actually, CVS is nice enough to stick a "Tag" in the checked out file system, so you don't have to remember the "<tt>-rOPENBSD_5_7</tt>" part -of the command line, it will remember this until you explicitly clear -them or set a new tag by using the "<tt>-A</tt>" option to +of the command line; it will remember this until you explicitly clear +it or set a new tag by using the "<tt>-A</tt>" option to "<tt>update</tt>". However, it is probably better to provide too much info in your CVS command lines than too little. @@ -491,7 +491,7 @@ Be very careful which tree you grab -- i <i>-current</i> when aiming for <i>-stable</i>. <h4>Pre-loading the tree: <tt>src.tar.gz, sys.tar.gz</tt></h4> -While you can download the entire source tree from an AnonCVS server, +While you can download the entire source tree from an <a href="../anoncvs.html">AnonCVS</a> server, you can sometimes save time and bandwidth by "pre-loading" your source tree with the source files from either the OpenBSD CD or from an FTP server. @@ -552,15 +552,18 @@ To get a successful update, you must use <p> <li>Experienced CVS users may wonder why the CVSROOT was specified and -used in this example, as cvs(1) will record the CVS server's location in +used in this example, as +<a href="http://www.openbsd.org/cgi-bin/man.cgi?query=cvs&sektion=1";>cvs(1)</a> +will record the CVS server's location in the checked out tree. This is correct, however there are enough times where one may need to -override the default anoncvs server, many people recommend <i>always</i> +override the default <a href="../anoncvs.html">AnonCVS</a> server, many people recommend <i>always</i> specifying the repository explicitly. It is also worth noting that while the CVSROOT environment variable can -be used directly by cvs(1), it is used only if nothing else overrides -it (i.e., cvs(1) would have an error without it), whereas specifying it -in the cvs(1) command line overrides all other values. +be used directly by <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=cvs&sektion=1";>cvs(1)</a>, +it is used only if nothing else overrides +it (i.e., there would be an error without it), whereas specifying it +on the command line overrides all other values. <p> <li>It is often useful to use a <tt>.cvsrc</tt> in your home directory to @@ -574,8 +577,8 @@ An example <tt>.cvsrc</tt> file: checkout -P </pre> -This file would cause cvs(1) to use the -<tt>anon...@anoncvs.example.org:/cvs</tt> server, suppress usually +This file would cause <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=cvs&sektion=1";>cvs(1)</a> +to use the <tt>anon...@anoncvs.example.org:/cvs</tt> server, suppress usually unneeded output ("<tt>-q</tt>" is "quiet") for all operations, a "cvs up" command defaults to using the <tt>-Pd</tt>, a "cvs diff" defaults to providing "unified diffs" due to the "<tt>-u</tt>", @@ -629,7 +632,7 @@ system. The source for the kernel is in the <tt>/usr/src/sys</tt> directory. Some parts of the OpenBSD kernel code are used on all platforms, others are very specific to one processor or one architecture. -If you look in the <tt>/usr/src/sys/arch/</tt> directory, you may see +If you look in the <tt>/usr/src/sys/arch</tt> directory, you may see some things that look a little confusing -- for example, there are <tt>mac68k</tt>, <tt>m68k</tt> and <tt>mvme68k</tt> directories. In this case, the mvme68k and mac68k systems both use the same @@ -702,7 +705,7 @@ Failing to do this step before building leave your <tt>src</tt> tree in bad shape. <p> -<li>Make sure all the appropriate directories are created. +<li>Make sure all the appropriate directories are created: <blockquote><pre> # <b>cd /usr/src/etc && env DESTDIR=/ make distrib-dirs</b> </pre></blockquote> @@ -740,7 +743,7 @@ If you have only one computer running Op reason to make a release, as the <a href="#Bld">above</a> build process will do everything you need. An example use of the release process would be to build <i>-stable</i> -on a fast machine, then make a release to be installed on all your other +on a fast machine, then make a release to be installed on all the other machines in your office. <p> @@ -759,12 +762,14 @@ The release process requires two work di DESTDIR and RELEASEDIR. All the files that are part of a "clean" OpenBSD install will be copied to their proper place within the DESTDIR. -They will then be tar(1)ed up and placed in the RELEASEDIR. +They will then be +<a href="http://www.openbsd.org/cgi-bin/man.cgi?query=tar&sektion=1";>tar(1)</a>ed +up and placed in the RELEASEDIR. At the end of the process, RELEASEDIR will hold the completed OpenBSD release. The release process will also use the <tt>/mnt</tt> location, so this should not be used by anything while the release process is running. -For the purpose of example, we will use the DESTDIR of +For the purpose of this example, we will use the DESTDIR of <tt>/usr/dest</tt> and the RELEASEDIR of <tt>/usr/rel</tt>. @@ -810,7 +815,7 @@ We now make the release itself: After the release is made, it is a good idea to check the release to make sure the tar files are matching what is in the DESTDIR. -The output of this step should be very minimal. +The output of this step should be very minimal: <blockquote><pre> # <b>cd /usr/src/distrib/sets</b> @@ -871,7 +876,7 @@ $ <b>cvs -qdanon...@anoncvs.example.org: <h3>Building Xenocara</h3> For building the standard xenocara tree as supported by OpenBSD, -no external tools are needed. +no external tools are needed: <blockquote><pre> # <b>cd /usr/xenocara</b> @@ -995,7 +1000,7 @@ Really. <p> OpenBSD kernel generation is controlled by configuration files, -which are located in the <tt>/usr/src/sys/arch/<i><arch></i>/conf/</tt> +which are located in the <tt>/usr/src/sys/arch/<i><arch></i>/conf</tt> directory by default. All architectures have a file, <tt>GENERIC</tt>, which is used to generate the standard OpenBSD kernel for that platform. There may also be other configuration files which are used to create @@ -1007,7 +1012,7 @@ The configuration file is processed by <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=config&sektion=8";>config(8)</a>, which creates and populates a compilation directory in <tt>../compile</tt>, on a typical installation, that would be in -<tt>/usr/src/sys/arch/<i><arch></i>/compile/</tt>. config(8) also creates +<tt>/usr/src/sys/arch/<i><arch></i>/compile</tt>. config(8) also creates a <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=make&sektion=1";>Makefile</a>, and other files required to successfully build the kernel. @@ -1039,7 +1044,8 @@ problem with a GENERIC kernel. Not all each other, and many options are required for the system to work. There is no guarantee that just because you manage to get a custom kernel compiled that it will actually run. -There is no guarantee that a kernel that can be "config(8)ed" can be +There is no guarantee that a kernel that can be +<a href="http://www.openbsd.org/cgi-bin/man.cgi?query=config&sektion=8";>config(8)</a>ed can be built. <p> @@ -1129,7 +1135,8 @@ boca0 at isa? port 0x100 irq 10 com* at boca? slave ? </pre></blockquote> -The two lines regarding the boca(4) card are copied from the commented +The two lines regarding the <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=boca&sektion=4";>boca(4)</a> +card are copied from the commented out lines in <tt>GENERIC</tt>, with the IRQ adjusted as needed. The advantage to using this "wrapper" file is any unrelated changes in GENERIC are updated automatically with any other source code update. @@ -1146,7 +1153,8 @@ configuration file. <p> In either event, after making your custom kernel configuration file, -use config(8) and make the kernel as documented +use <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=config&sektion=8";>config(8)</a> +and make the kernel as documented <a href="#BldKernel">above</a>. @@ -1184,13 +1192,13 @@ UKC prompt. From here you can issue comm specifying devices you want to change or disable or even enable. <p> -Here is a list of common commands in the UKC. +Here is a list of common commands in the UKC: <ul> <li><tt>add <strong>device</strong></tt> - Add a device through copying another <li><tt>change <strong>devno | device </strong></tt> - Modify one or more devices -<li><tt>disable <strong>devno | device </strong></tt> - Disable one or more devices -<li><tt>enable <strong>devno | device </strong></tt> - Enable one or more devices +<li><tt>disable <strong>devno | device </strong></tt> - Disable one or more devices +<li><tt>enable <strong>devno | device </strong></tt> - Enable one or more devices <li><tt>find <strong>devno | device </strong></tt> - Find one or more devices <li><tt>help</tt> - Short summary of these commands <li><tt>list</tt> - List ALL known devices @@ -1445,9 +1453,8 @@ Here are some other resources: <li><a href="http://www.openbsd.org/cgi-bin/man.cgi?query=mk.conf&sektion=5";>mk.conf(5)</a> <li><a href="http://www.openbsd.org/cgi-bin/man.cgi?query=options&sektion=4";>options(4)</a> <li><a href="http://cvsweb.openbsd.org/cgi-bin/cvsweb/src/Makefile";><tt>/usr/src/Makefile</tt></a> -<li><a href="../stable.html">Patch Branches</a> (<i>-stable</i>) +<li><a href="../stable.html">Patch branch</a> (<i>-stable</i>) <li>(for X) <tt>/usr/X11R6/README</tt> on your installed system - </ul> <h3 id="NoSnaps">5.11.8 - I didn't see any snapshots on the FTP site. Where
