docs/114176: readability improvement to handbook install chapter

Benjamin Kaduk kaduk at prolepsis.scs.uiuc.edu
Sat Jun 30 23:40:03 UTC 2007


>Number:         114176
>Category:       docs
>Synopsis:       readability improvement to handbook install chapter
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sat Jun 30 23:40:02 GMT 2007
>Closed-Date:
>Last-Modified:
>Originator:     Ben Kaduk
>Release:        FreeBSD 7.0-CURRENT i386
>Organization:
>Environment:
System: FreeBSD prolepsis.scs.uiuc.edu 7.0-CURRENT FreeBSD 7.0-CURRENT #1: Sun Apr 1 16:59:00 UTC 2007 kaduk at prolepsis.scs.uiuc.edu:/usr/obj/usr/src/sys/GENERIC i386


	
>Description:
	When viewing the handbook online, in the section on allocating disk space,
there is a table describing a partitioning scheme for installing FreeBSD.
However, in this table, the ``b'' partition is the only one which has a
multi-paragraph description.  This can cause confusion, as the vertical 
separation between rows of the table is approximatly the same as the
separation between pararaphs, and the first paragraph describing the swap
partition begins ``this partition''.  I propose to make explicit which
partition is being referred to, instead of relying on the user to 
correctly parse our table (which perhaps does not render as well as
it could).
>How-To-Repeat:
	http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/install-steps.html
>Fix:

--- chapter.sgml.orig   Sat Jun 30 17:15:48 2007
+++ chapter.sgml        Sat Jun 30 17:23:11 2007
@@ -1725,7 +1714,8 @@

              <entry>2-3 x RAM</entry>

-             <entry><para>The system's swap space is kept on this partition.
+             <entry><para>The system's swap space is kept on the
+                 <literal>b</literal>partition.
                  Choosing the right amount of swap space can be a bit of an
                  art.  A good rule of thumb is that your swap
                  space should be two or three times as much as the


>Release-Note:
>Audit-Trail:
>Unformatted:



More information about the freebsd-doc mailing list