Document in SalvageLog(5) the per-partition salvager logs

Document that salvager creates separate logs per partition when doing
a full server salvage and then appends them all to SalvageLog when it
completes.

Change-Id: I2ffa8c79ef83b590f90bb014fc318559deae7113
Reviewed-on: http://gerrit.openafs.org/2035
Reviewed-by: Russ Allbery <rra@stanford.edu>
Tested-by: Russ Allbery <rra@stanford.edu>

diff --git a/doc/man-pages/README b/doc/man-pages/README
index dbf7675a9c7ac11609f3405e5268af595864ee02..a31bb600f5a884eedd0ba08111285f0313563221 100644 (file)
--- a/doc/man-pages/README
+++ b/doc/man-pages/README
@@ -230,9 +230,6 @@ Known Problems
   don't just report the deficiency again, but any contributions towards
   fixing it are greatly appreciated.
 
-   * The salvager actually creates a bunch of SalvageLog files and then
-     combines them, but the SalvageLog man page doesn't reflect this.
-
    * There's no mention of the Kerberos v5 support.  At least, we need
      some disclaimers under klog and friends talking about sites without
      kaserver (and possibly without fakeka), and deprecation warnings

diff --git a/doc/man-pages/pod5/SalvageLog.pod b/doc/man-pages/pod5/SalvageLog.pod
index 679b3bc977669b07829310c7d5195049a26be33d..cdc3aa3cc285c53fc231e089e57ad9ccd85ad82a 100644 (file)
--- a/doc/man-pages/pod5/SalvageLog.pod
+++ b/doc/man-pages/pod5/SalvageLog.pod
@@ -14,6 +14,14 @@ initial start-up messages to it. If there is an existing file, the
 Salvager renames is to F<SalvageLog.old>, overwriting the existing
 F<SalvageLog.old> file if it exists.
 
+When the Salvager is salvaging an entire file server, it creates a
+separate log file for each partition it starts salvaging. That file will
+be named F<SalvageLog.I<job>> where I<job> is a job number that will
+normally (but is not guaranteed to) correspond to the index of the
+partition being salvaged. Once salvaging of all partitions is complete,
+the Salvager will accumulate all the partition-specific log files, append
+them to F<SalvageLog>, and then remove the partition-specific files.
+
 The file is in ASCII format. Administrators listed in the
 F</usr/afs/etc/UserList> file can use the B<bos getlog> command to display
 its contents. Alternatively, log onto the file server machine and use a