Bug 58111

Summary: Handbook 12.4.3 Rebuilding ATA RAID1 Arrays contains errors
Product: Documentation Reporter: Jack Twilley <jmt>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Jack Twilley 2003-10-16 09:20:09 UTC
        Section 12.4.3 of the FreeBSD Handbook discusses rebuilding
        ATA RAID1 arrays.  The example case is of a Promise IDE RAID
        card.  I have one of these, and recently had the need to rebuild
        the RAID array.  During this process, I discovered two errors
        in the documentation:

         * step 3 is incomplete
           "Reattach the disk as a spare:" has a command to reattach 
           the disk, but no command to attach the new disk to the array
           as a spare disk.

         * step 5 is obsolete
           The documentation reports that the rebuild command hangs until
           complete.  In fact, the rebuild command returns immediately
           and the disk is rebuilt in the background.

Fix: 

Replace the old step 3 with something like this:

        3.  Reattach the disk as a spare:

		# atacontrol attach 3
		Master:  ad6 <MAXTOR 6L080J4/A93.0500> ATA/ATAPI rev 5
		Slave:   no device present
		# atacontrol addspare ar0 ad6
		<appropriate output here, stupidly didn't save it>

        Replace the old step 5 with something like this:

        5.  The rebuild command returns immediately.  You can check on
            the progress by issuing the following command:
Comment 1 army 2004-04-20 09:01:19 UTC
I just got bitten with this too.
Perhapse someone would care to apply the following patch?

Thanks,
Paul

--- book.html	Mon Feb 23 20:33:54 2004
+++ /tmp/book.html	Mon Apr 19 17:31:07 2004
@@ -28726,7 +28726,7 @@
 </li>
 
 <li>
-<p>Reattach the disk as a spare:</p>
+<p>Reattach the disk:</p>
 
 <pre class="SCREEN">
 <samp class="PROMPT">#</samp> <kbd class="USERINPUT">atacontrol attach 3</kbd>
@@ -28736,6 +28736,13 @@
 </li>
 
 <li>
+<p>Attach the disk as a spare:</p>
+<pre class="SCREEN">
+<samp class="PROMPT">#</samp> <kbd class="USERINPUT">atacontrol addspare ar0 ad6</kbd>
+</pre>
+</li>
+
+<li>
 <p>Rebuild the array:</p>
 
 <pre class="SCREEN">
@@ -28744,7 +28751,8 @@
 </li>
 
 <li>
-<p>The rebuild command hangs until complete. However, it is possible to open another
+<p>On older versions of FreeBSD, the rebuild command may hang until complete. 
+However, it is possible to open another
 terminal (using <b class="KEYCAP">Alt</b>+<b class="KEYCAP">F<var
 class="REPLACEABLE">n</var></b>) and check on the progress by issuing the
 following command:</p>
Comment 2 Siebrand Mazeland 2005-02-27 22:54:02 UTC
The submitted patch was on the HTML page. Below you find a patch to the
source file. Please evaluate.

Cheers!

Index: en_US.ISO8859-1/books/handbook/disks/chapter.sgml
===================================================================
RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/handbook/disks/chapter.sgml,v
retrieving revision 1.232
diff -u -r1.232 chapter.sgml
--- en_US.ISO8859-1/books/handbook/disks/chapter.sgml	27 Feb 2005 12:59:47
-0000	1.232
+++ en_US.ISO8859-1/books/handbook/disks/chapter.sgml	27 Feb 2005 22:51:59
-0000
@@ -716,7 +716,7 @@
 	</step>
 
 	<step>
-	  <para>Reattach the disk as a spare:</para>
+	  <para>Reattach the disk:</para>
 
 	  <screen>&prompt.root; <userinput>atacontrol attach 3</userinput>
 Master:  ad6 &lt;MAXTOR 6L080J4/A93.0500&gt; ATA/ATAPI rev 5
@@ -724,15 +724,24 @@
 	</step>
 
 	<step>
+	  <para>Reattach the disk as a spare:</para>
+
+	  <screen>&prompt.root; <userinput>atacontrol addspare ar0
ad6</userinput></screen>
+	</step>
+
+	<step>
 	  <para>Rebuild the array:</para>
 
 	  <screen>&prompt.root; <userinput>atacontrol rebuild
ar0</userinput></screen>
 	</step>
 
 	<step>
-	  <para>The rebuild command hangs until complete.  However, it is
possible to open another
-	  terminal (using <keycombo action="simul"><keycap>Alt</keycap>
<keycap>F<replaceable>n</replaceable></keycap></keycombo>)
-          and check on the progress by issuing the following
command:</para>
+	  <para>On older versions of FreeBSD, the rebuild command may
+	    hang until complete.  However, it is possible to open
+	    another terminal (using <keycombo
+	      action="simul"><keycap>Alt</keycap>
<keycap>F<replaceable>n</replaceable></keycap></keycombo>)
+	    and check on the progress by issuing the following
+	    command:</para>
 
 	  <screen>&prompt.root; <userinput>dmesg | tail -10</userinput>
 [output removed]
Comment 3 Pav Lucistnik freebsd_committer freebsd_triage 2005-12-18 18:40:39 UTC
State Changed
From-To: open->closed

I just updated The Handbook to match the reality of FreeBSD 6.0.