Date: Tue, 24 Jun 2014 18:41:27 +0000 (UTC) From: Warren Block <wblock@FreeBSD.org> To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r45116 - head/en_US.ISO8859-1/books/handbook/geom Message-ID: <201406241841.s5OIfRCp075225@svn.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: wblock Date: Tue Jun 24 18:41:26 2014 New Revision: 45116 URL: http://svnweb.freebsd.org/changeset/doc/45116 Log: Convert some <command> elements in the gmirror section to man page references where the text is referring to the system rather than the command name. Convert some passive voice to active. Clarify. Modified: head/en_US.ISO8859-1/books/handbook/geom/chapter.xml Modified: head/en_US.ISO8859-1/books/handbook/geom/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/handbook/geom/chapter.xml Tue Jun 24 15:50:48 2014 (r45115) +++ head/en_US.ISO8859-1/books/handbook/geom/chapter.xml Tue Jun 24 18:41:26 2014 (r45116) @@ -263,7 +263,7 @@ Done.</screen> </indexterm> <para><acronym>RAID1</acronym>, or - <firstterm>mirroring</firstterm>, is the technique of writing + <emphasis>mirroring</emphasis>, is the technique of writing the same data to more than one disk drive. Mirrors are usually used to guard against data loss due to drive failure. Each drive in a mirror contains an identical copy of the data. When @@ -295,7 +295,7 @@ Done.</screen> </warning> <warning> - <para>While <command>dump</command> is used in these procedures + <para>While &man.dump.8; is used in these procedures to copy file systems, it does not work on file systems with soft updates journaling. See &man.tunefs.8; for information on detecting and disabling soft updates journaling.</para> @@ -311,14 +311,14 @@ Done.</screen> old metadata from a previous mirror.</para> <para><acronym>GPT</acronym> metadata can be erased with - <command>gpart</command>. This example erases both primary + &man.gpart.8;. This example erases both primary and backup <acronym>GPT</acronym> partition tables from disk <filename>ada8</filename>:</para> <screen>&prompt.root; <userinput>gpart destroy -F ada8</userinput></screen> <para>A disk can be removed from an active mirror and the - metadata erased in one step using <command>gmirror</command>. + metadata erased in one step using &man.gmirror.8;. Here, the example disk <filename>ada8</filename> is removed from the active mirror <filename>gm4</filename>:</para> @@ -330,15 +330,15 @@ Done.</screen> <screen>&prompt.root; <userinput>gmirror clear ada8</userinput></screen> - <para>When <command>gmirror</command> is used, one block of - metadata is stored at the end of the disk. Because + <para>&man.gmirror.8; stores one block of + metadata at the end of the disk. Because <acronym>GPT</acronym> partition schemes also store metadata at the end of the disk, mirroring entire - <acronym>GPT</acronym> disks with <command>gmirror</command> + <acronym>GPT</acronym> disks with &man.gmirror.8; is not recommended. <acronym>MBR</acronym> partitioning is used here because it only stores a partition table at the - start of the disk and does not conflict with - <command>gmirror</command>.</para> + start of the disk and does not conflict with the + mirror metadata.</para> </sect2> <sect2 xml:id="geom-mirror-two-new-disks"> @@ -361,14 +361,14 @@ Done.</screen> <screen>&prompt.root; <userinput>gmirror label -v gm0 /dev/ada1 /dev/ada2</userinput></screen> - <para>In this example, <filename>gm0</filename> is a user-chosen + <para><filename>gm0</filename> is a user-chosen device name assigned to the new mirror. After the mirror has - been started, this device name will appear in + been started, this device name appears in <filename>/dev/mirror/</filename>.</para> <para><acronym>MBR</acronym> and <application>bsdlabel</application> partition tables can now - be created on the mirror with <command>gpart</command>. This + be created on the mirror with &man.gpart.8;. This example uses a traditional file system layout, with partitions for <filename>/</filename>, swap, <filename>/var</filename>, <filename>/tmp</filename>, and <filename>/usr</filename>. A @@ -422,7 +422,7 @@ Done.</screen> <para>File systems from the original <filename>ada0</filename> disk can now be copied onto the mirror with - <command>dump</command> and <command>restore</command>.</para> + &man.dump.8; and &man.restore.8;.</para> <screen>&prompt.root; <userinput>mount /dev/mirror/gm0s1a /mnt</userinput> &prompt.root; <userinput>dump -C16 -b64 -0aL -f - / | (cd /mnt && restore -rf -)</userinput> @@ -433,7 +433,7 @@ Done.</screen> &prompt.root; <userinput>dump -C16 -b64 -0aL -f - /tmp | (cd /mnt/tmp && restore -rf -)</userinput> &prompt.root; <userinput>dump -C16 -b64 -0aL -f - /usr | (cd /mnt/usr && restore -rf -)</userinput></screen> - <para>Next, edit <filename>/mnt/etc/fstab</filename> to point to + <para>Edit <filename>/mnt/etc/fstab</filename> to point to the new mirror file systems:</para> <programlisting># Device Mountpoint FStype Options Dump Pass# @@ -493,16 +493,16 @@ Done.</screen> 1000204821504 # mediasize in bytes (931G)</screen> <para>Create a mirror on the new disk. To make certain that the - mirror capacity is not any larger than the original drive, - <command>gnop</command> is used to create a fake drive of the + mirror capacity is not any larger than the original <filename>ada0</filename> drive, + &man.gnop.8; is used to create a fake drive of the exact same size. This drive does not store any data, but is used only to limit the size of the mirror. When - <command>gmirror</command> creates the mirror, it will + &man.gmirror.8; creates the mirror, it will restrict the capacity to the size of - <filename>gzero.nop</filename>, even if the new drive - (<filename>ada1</filename>) has more space. Note that the + <filename>gzero.nop</filename>, even if the new + <filename>ada1</filename> drive has more space. Note that the <replaceable>1000204821504</replaceable> in the second line - should be equal to <filename>ada0</filename>'s media size as + is equal to <filename>ada0</filename>'s media size as shown by <command>diskinfo</command> above.</para> <screen>&prompt.root; <userinput>geom zero load</userinput> @@ -524,7 +524,7 @@ Done.</screen> <filename>ada0</filename> to the new mirror.</para> <para>However, if the output shows that all of the space on the - disk is allocated, like in the following listing, there is no + disk is allocated, as in the following listing, there is no space available for the 512-byte mirror metadata at the end of the disk.</para> @@ -562,8 +562,8 @@ BSD 8 6 freebsd-ufs 130023424 838860800 7 freebsd-ufs 968884224 984640881</screen> - <para>If the output of <command>gpart show</command> shows no - free space at the end of the disk, the size of both the slice + <para>If no + free space is shown at the end of the disk, the size of both the slice and the last partition must be reduced by one sector. Edit the two files, reducing the size of both the slice and last partition by one. These are the last numbers in each @@ -615,11 +615,11 @@ BSD 8 710934528 1242590514 7 freebsd-ufs (592G) 1953525042 63 - free - (31k)</screen> - <para>Both the slice and the last partition should have some - free space at the end of each disk.</para> + <para>Both the slice and the last partition must have at least + one free block at the end of the disk.</para> <para>Create file systems on these new partitions. The number - of partitions will vary, matching the partitions on the + of partitions will vary to match the original disk, <filename>ada0</filename>.</para> <screen>&prompt.root; <userinput>newfs -U /dev/mirror/gm0s1a</userinput> @@ -656,15 +656,15 @@ BSD 8 <para>If the <filename>geom_mirror.ko</filename> kernel module has not been built into the kernel, edit - <filename>/boot/loader.conf</filename> to load it:</para> + <filename>/boot/loader.conf</filename> to load it at boot:</para> <programlisting>geom_mirror_load="YES"</programlisting> <para>File systems from the original disk can now be copied onto - the mirror with <command>dump</command> and - <command>restore</command>. Note that it may take some time - to create a snapshot for each file system dumped with - <command>dump -L</command>.</para> + the mirror with &man.dump.8; and + &man.restore.8;. + Each file system dumped with + <command>dump -L</command> will create a snapshot first, which can take some time.</para> <screen>&prompt.root; <userinput>mount /dev/mirror/gm0s1a /mnt</userinput> &prompt.root; <userinput>dump -C16 -b64 -0aL -f - / | (cd /mnt && restore -rf -)</userinput> @@ -693,15 +693,15 @@ BSD 8 <important> <para>When <filename>ada0</filename> is inserted into the - mirror, its former contents will be overwritten by data on + mirror, its former contents will be overwritten by data from the mirror. Make certain that <filename>mirror/gm0</filename> has the same contents as <filename>ada0</filename> before adding - <filename>ada0</filename> to the mirror. If there is - something wrong with the contents copied by - <command>dump</command> and <command>restore</command>, + <filename>ada0</filename> to the mirror. If the contents + previously copied by + &man.dump.8; and &man.restore.8; are not identical to what was on <filename>ada0</filename>, revert <filename>/etc/fstab</filename> to mount the file - systems on <filename>ada0</filename>, reboot, and try the + systems on <filename>ada0</filename>, reboot, and start the whole procedure again.</para> </important> @@ -725,7 +725,7 @@ mirror/gm0 DEGRADED ada1 (ACTIVE) mirror/gm0 COMPLETE ada1 (ACTIVE) ada0 (ACTIVE)</screen> - <para>The mirror, <filename>mirror/gm0</filename>, now consists + <para><filename>mirror/gm0</filename> now consists of the two disks <filename>ada0</filename> and <filename>ada1</filename>, and the contents are automatically synchronized with each other. In use, @@ -826,7 +826,7 @@ mountroot></screen> <para>Any old metadata should be cleared from the replacement disk using the instructions in <xref - linkend="geom-mirror-metadata"/>. Then the disk, + linkend="geom-mirror-metadata"/>. Then the replacement disk, <filename>ada4</filename> for this example, is inserted into the mirror:</para>
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201406241841.s5OIfRCp075225>