From: Andrew Deason Date: Thu, 15 Feb 2018 22:53:57 +0000 (-0600) Subject: doc: Edits to the 'afsd -volume-ttl' manpage X-Git-Tag: upstream/1.8.0^2~4 X-Git-Url: https://git.michaelhowe.org/gitweb/?a=commitdiff_plain;h=3d58c397c6935afd64e3a41017baf627106a3003;p=packages%2Fo%2Fopenafs.git doc: Edits to the 'afsd -volume-ttl' manpage Make a few misc changes to the text for the new -volume-ttl option: - Minor grammatical/typo fixes - Emphasize a little more that the default behavior allows for vldb info to be cached _forever_ - Provide some info on the effects of changing this value - Provide a suggested "typical" value, to give some clue as to what should be set here, so a curious user doesn't just set this to the first value they see (10 minutes) Reviewed-on: https://gerrit.openafs.org/12909 Reviewed-by: Benjamin Kaduk Tested-by: Andrew Deason (cherry picked from commit e6c2624249a6ab96053c1d1134aec8e3f6bcee9e) Change-Id: I781ec2e8b4873093f65d11b5883f8b74ad397cff Reviewed-on: https://gerrit.openafs.org/12913 Tested-by: BuildBot Reviewed-by: Benjamin Kaduk --- diff --git a/doc/man-pages/pod8/afsd.pod b/doc/man-pages/pod8/afsd.pod index 6114a7e5c..65a27a630 100644 --- a/doc/man-pages/pod8/afsd.pod +++ b/doc/man-pages/pod8/afsd.pod @@ -760,14 +760,21 @@ Specifies the maximum amount of time the Cache Manager will cache volume information retrieved from VL Servers. By default, the Cache Manager will cache read-only volume information as long -as a volume callback is held for a read-only volume. The callback may be held -as long as files in the read-only volume are being accessed. The Cache Manager -will cache read/write volume information as long as volume level errors are not -returned from fileservers while accessing files within the volume. - -Use the B<-volume-ttl> to specify the maximum amount of time in seconds -volume information will be cached, regardless of connectivity to the -fileserers. The minimum valid value is 600 seconds (10 minutes). +as a volume callback is held for that volume. The callback may be held as long +as files in the read-only volume are being accessed, with no upper limit. For +read/write volumes, by default the Cache Manager will cache volume information +forever, until a fileserver returns a volume-level error in response to +accessing files in that volume. + +Use the B<-volume-ttl> option to specify the maximum amount of time in seconds +that volume information will be cached, regardless of connectivity to the +fileservers. Lowering this value can make the Cache Manager recover more +quickly from certain volume/fileserver errors, but will increase the load on +the VL Servers for contacted cells. + +A typical value is 7200 seconds (2 hours), which is the same as the default +callback duration for read-only volumes. The minimum valid value is 600 seconds +(10 minutes). =back