| Summary: | readability improvement to handbook install chapter | ||
|---|---|---|---|
| Product: | Documentation | Reporter: | Benjamin Kaduk <kaduk> |
| Component: | Books & Articles | Assignee: | Murray Stokely <murray> |
| Status: | Closed FIXED | ||
| Severity: | Affects Only Me | ||
| Priority: | Normal | ||
| Version: | Latest | ||
| Hardware: | Any | ||
| OS: | Any | ||
State Changed From-To: open->closed Submitted in r1.352 of install/chapter.sgml. Thanks for the submission. Website will be updated later today. I added a space between 'b' and 'partition' in your patch. Responsible Changed From-To: freebsd-doc->murray Submitted in r1.352 of install/chapter.sgml. Thanks for the submission. Website will be updated later today. I added a space between 'b' and 'partition' in your patch. |
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). Fix: <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--rrhb9JicNzZndJ8RQHj2WKewBw5Ktf34Y0HSATCdoSBKOfGg Content-Type: text/plain; name="file.diff" Content-Transfer-Encoding: 7bit Content-Disposition: attachment; filename="file.diff" --- chapter.sgml.orig Sat Jun 30 17:15:48 2007 +++ chapter.sgml Sat Jun 30 17:23:11 2007 @@ -1725,7 +1714,8 @@ How-To-Repeat: http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/install-steps.html