man-page-salvager-fixes-20090201
authorRuss Allbery <rra@stanford.edu>
Mon, 2 Feb 2009 01:19:00 +0000 (01:19 +0000)
committerRuss Allbery <rra@stanford.edu>
Mon, 2 Feb 2009 01:19:00 +0000 (01:19 +0000)
LICENSE BSD

Fix the -parallel example in the main description text: "5all" should be
"all5".  Reword the description a bit to hopefully make it clearer that
there are two separate values set here.  Note under the option description
of -parallel that multiple partitions on the same device are normally
processed serially.

doc/man-pages/pod8/salvager.pod

index 2057e15..f7009c6 100644 (file)
@@ -102,11 +102,13 @@ Salvager by default salvages them serially to avoid the inefficiency of
 constantly moving the disk head from one partition to another. However,
 this strategy is often not ideal if the partitions are configured as
 logical volumes that span multiple disks. To force the Salvager to salvage
-logical volumes in parallel, provide the string C<all> as the value for
-the B<-parallel> argument. Provide a positive integer to specify the
-number of subprocesses to run in parallel (for example, C<-parallel 5all>
-for five subprocesses), or omit the integer to run up to four
-subprocesses, depending on the number of logical volumes being salvaged.
+logical volumes in parallel as if they were on separate disks, provide the
+string C<all> as the value for the B<-parallel> argument.
+
+To set both parameters at the same time, append the number of Salvager
+processes to the string C<all>. For example, C<-parallel all5> treats
+each partition as a separate disk and runs five Salvager processes, thus
+salvaging five partitions at a time.
 
 The Salvager creates temporary files as it runs, by default writing them
 to the partition it is salvaging. The number of files can be quite large,
@@ -230,7 +232,7 @@ volumes. Use this value only with such logical volumes.
 The BOS Server never starts more Salvager subprocesses than there are
 partitions, and always starts only one process to salvage a single
 volume. If this argument is omitted, up to four Salvager subprocesses run
-in parallel.
+in parallel but partitions on the same device are salvaged serially.
 
 =item B<-tmpdir> <I<name of dir to place tmp files>>