Bug 164920

Summary: [PATCH] changes to swap section of config chapter
Product: Documentation Reporter: Niclas Zeising <zeising>
Component: Books & ArticlesAssignee: Eitan Adler <eadler>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
handbook.config.chapter.sgml.diff
none
handbook.config.chapter.sgml.diff
none
handbook.config.chapter.sgml.diff
none
harmful-chemicals.diff none

Description Niclas Zeising 2012-02-09 00:10:07 UTC 
	The section about adding swap space on a new harddrive in the configuation and tuning chapter of the handbook is rather inadequate, and the language used is perhaps not entirely suitable for the handbook.

Fix: Attached patch rewrites this section of the handbook to add a more throughout and clear explanation on how to add more swap space using an existing or new harddrive.
	Prodded by: A friend who at first couldn't figure out how to add more swap space to a machine.
Comment 1 Eitan Adler freebsd_committer freebsd_triage 2012-02-09 00:11:30 UTC 
Responsible Changed
From-To: freebsd-doc->eadler

I'll take it.
Comment 2 Niclas Zeising 2012-02-09 15:33:48 UTC 
For some reason, the patch I attached to the PR has been mangled.  Here
is the patch again, hopefully this time it works better.
-- 
Niclas
Comment 3 Benedict Reuschling freebsd_committer freebsd_triage 2012-02-09 16:06:18 UTC 
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Index: en_US.ISO8859-1/books/handbook/config/chapter.sgml
===================================================================
RCS file:
/home/ncvs/doc/en_US.ISO8859-1/books/handbook/config/chapter.sgml,v
retrieving revision 1.250
diff -u -d -r1.250 chapter.sgml
- --- en_US.ISO8859-1/books/handbook/config/chapter.sgml     31 Jan 2012
14:14:59 -0000      1.250
+++ en_US.ISO8859-1/books/handbook/config/chapter.sgml    8 Feb 2012
23:14:35 -0000
@@ -2390,15 +2390,37 @@
       <xref linkend="swap-encrypting"> of the Handbook.</para>

     <sect2 id="new-drive-swap">
- -      <title>Swap on a New Hard Drive</title>
+      <title>Swap on a New or Existing Hard Drive</title>

- -      <para>The best way to add swap, of course, is to use this as an
- -   excuse to add another hard drive.  You can always use another
- - hard drive, after all.  If you can do this, go reread the
- -     discussion of swap space
- -      in <xref linkend="configtuning-initial">
- -      of the Handbook for some suggestions on how to best
- -   arrange your swap.</para>
+      <para>The best way, and the way that gives most performance, is
to add
+   a new swap partition on an existing or new hard drive.  How to set up
+ partitions and harddrives is explaned in <xref linkend="disks-adding">

s/explaned/explained

+        and <xref linkend="configtuning-initial"> contains a discussion on
+    partition layouts and swap partition size considerations.</para>

There must be a blank line here between the </para> and the <para> tags.

+      <para>When a partition is prepared and selected, &man.swapon.8;
is used
+       to add the partition to the system.  If the partition is
+      <filename>/dev/ada1s1p2</filename>, this will look like:</para>
+
+      <screen>&prompt.root; <userinput>swapon
+    <replaceable>/dev/ada1s1p2</replaceable></userinput></screen>
+
+      <warning>
+        <para>It is posible to use any partition not currently
s/posible/possible

mounted, even
+      if it contains a file system.  If the partition contains a file
+       system and is mounted as swap space, the filesystem will be

You need to decide on a canonical form: it's either file system or
filesystem, but not both in one patch. ;-)


Other than that, I see nothing wrong with the patch.

Regards

Benedict Reuschling
FreeBSD Documentation Committer

The FreeBSD Documentation Project
FreeBSD German Documentation Project - https://doc.bsdgroup.de
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.8 (Darwin)
Comment: GPGTools - http://gpgtools.org
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAk8z7voACgkQTSZQLkqBk0iC1ACghD7tLf9+rcGyX+FhCKj0ghgQ
3h8AoKdTMDbshO7KBuU9nvMvWfvAFnzl
=XiwG
-----END PGP SIGNATURE-----
Comment 4 Niclas Zeising 2012-02-09 19:02:40 UTC 
Here is a new patch fixing the things bcr@ found.
Regards!
-- 
Niclas
Comment 5 Eitan Adler freebsd_committer freebsd_triage 2012-03-03 03:23:20 UTC 
State Changed
From-To: open->analyzed

awaiting review
Comment 6 Niclas Zeising 2012-03-03 13:42:13 UTC 
Where is the lastest revision, so I know what to look through?
Regards!
-- 
Niclas Zeising
Comment 7 Eitan Adler freebsd_committer freebsd_triage 2012-03-17 05:11:55 UTC 
What about this version?

-- 
Eitan Adler
Comment 8 dfilter service freebsd_committer freebsd_triage 2012-03-26 17:42:41 UTC 
eadler      2012-03-26 16:42:26 UTC

  FreeBSD doc repository (src,ports committer)

  Modified files:
    en_US.ISO8859-1/books/handbook/config chapter.sgml 
  Log:
  Rewrite the config chapter to be more clear and use professional language.
  
  PR:             docs/164920
  Submitted by:   Niclas Zeising <zeising@daemonic.se>
  Reviewed by:    gjb (older version)
  Approved by:    bcr
  
  Revision  Changes    Path
  1.252     +50 -26    doc/en_US.ISO8859-1/books/handbook/config/chapter.sgml
_______________________________________________
cvs-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/cvs-all
To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
Comment 9 Eitan Adler freebsd_committer freebsd_triage 2012-03-26 17:58:36 UTC 
State Changed
From-To: analyzed->closed

Committed. Thanks!