doc: Clarify some BosConfig.new text
authorAndrew Deason <adeason@sinenomine.net>
Tue, 15 Apr 2014 17:30:19 +0000 (12:30 -0500)
committerJeffrey Altman <jaltman@your-file-system.com>
Wed, 21 May 2014 00:26:30 +0000 (20:26 -0400)
It is not always clear to users whether BosConfig.new is noticed
during an automatic restart, or if it requires stopping and starting
the bosserver. Slightly reword the relevant text and add a small note
that a "general restart" does cause BosConfig.new to be noticed, so
this is explicitly clear.

Change-Id: Iab3eaff176305b0b2991a6636e70204b5072b1b0
Reviewed-on: http://gerrit.openafs.org/11076
Reviewed-by: Andrew Deason <adeason@sinenomine.net>
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Jeffrey Altman <jaltman@your-file-system.com>

doc/man-pages/pod5/BosConfig.pod

index e172789..b610cee 100644 (file)
@@ -213,8 +213,11 @@ The B<bos startup> command starts a process.
 When the BOS Server shuts down, it rewrites F<BosConfig>, discarding any
 changes made manually to that file.  To change the configuration for the
 next BOS Server restart, instead write a new file to F<BosConfig.new>.  If
-F<BosConfig.new> exists when the BOS Server starts, it will rename that
-file to F<BosConfig> before reading its configuration.
+F<BosConfig.new> exists when the BOS Server starts, F<BosConfig> will be
+replaced by F<BosConfig.new> before the BOS Server reads its configuration.
+Note that the BOS Server will notice a new F<BosConfig.new> file whenever the
+I<general restart> time is reached, if one is configured, since the BOS Server
+restarts itself at that time.
 
 =head1 SEE ALSO