[OpenAFS-Doc] openafs-devel-1_5 fileserver man page updates

[Steven Jenkins]

These are the updates for the fileserver man page for the
openafs-devel-1_5 branch, including DAFS (Demand Attach). I have gone
through and verified each of the arguments to the fileserver and
ensured each option is documented (even when it's not fully
supported). Please let me know of any feedback or corrections.

Thanks,
Steven Jenkins

[Russ Allbery]

Post by Steven Jenkins
These are the updates for the fileserver man page for the
openafs-devel-1_5 branch, including DAFS (Demand Attach). I have gone
through and verified each of the arguments to the fileserver and ensured
each option is documented (even when it's not fully supported). Please
let me know of any feedback or corrections.
+B<Demand-Attach only:>
+ S<<< [B<-fs-state-dont-save>] >>>

Unfortunately, while this would be nice, this tends to confuse man page
parsers and it's better to just list all of the options and comment later
when they're not supported in particular situations. I've made that change.

Post by Steven Jenkins
+=item B<-fs-state-verify> <I<none | save | restore | both>>

Just (none | save | restore | both) here.

Post by Steven Jenkins
+This argument controls the behavior of the state verification
+mechanism. A value of <I none> turns off all

C<none> here, and likewise in the rest. I've made those changes.

Otherwise, looks good to me. Applied (to TRUNK and 1.5). Thanks!

[Steven Jenkins]

On Tue, Mar 11, 2008 at 9:26 PM, Russ Allbery <***@stanford.edu> wrote:
... (several editing issues that Steven missed but Russ caught)

Thanks for the editing help. I refreshed my copy and notice the
following patch needs to be applied, though:

--- man-pages/pod8/fileserver.pod 12 Mar 2008 01:40:16 -0000 1.5.2.7
+++ man-pages/pod8/fileserver.pod 12 Mar 2008 13:51:06 -0000
@@ -536,8 +536,7 @@

=item B<-vlruinterval <I<seconds>>

-The number of seconds between VLRU candidate queue scan default is 120 s.
-The second s.
+The number of seconds between VLRU candidate queue scan default is 120 seconds.

This option is only supported by the demand-attach file server.

Also, I thought hard about alphabetizing the options, given that there
are now 50 of them. However, that would break quite a bit of the
logical flow: currently, most options are grouped with similar ones.

Certainly if there are strong opinions, we can do something else with
the ordering.

Thanks,
Steven

[Jason Edgecombe]

Post by Steven Jenkins
... (several editing issues that Steven missed but Russ caught)
Thanks for the editing help. I refreshed my copy and notice the
--- man-pages/pod8/fileserver.pod 12 Mar 2008 01:40:16 -0000 1.5.2.7
+++ man-pages/pod8/fileserver.pod 12 Mar 2008 13:51:06 -0000
@@ -536,8 +536,7 @@
=item B<-vlruinterval <I<seconds>>
-The number of seconds between VLRU candidate queue scan default is 120 s.
-The second s.
+The number of seconds between VLRU candidate queue scan default is 120 seconds.
This option is only supported by the demand-attach file server.
Also, I thought hard about alphabetizing the options, given that there
are now 50 of them. However, that would break quite a bit of the
logical flow: currently, most options are grouped with similar ones.
Certainly if there are strong opinions, we can do something else with
the ordering.

I alphabetized the options in the afsd man page, but not anywhere else.
One problem is that if the options are alphabetized, then you can't omit
the "-option" on the command line because it expects the options in a
certain order.

Jason

[Russ Allbery]

Post by Steven Jenkins
Thanks for the editing help. I refreshed my copy and notice the
--- man-pages/pod8/fileserver.pod 12 Mar 2008 01:40:16 -0000 1.5.2.7
+++ man-pages/pod8/fileserver.pod 12 Mar 2008 13:51:06 -0000
@@ -536,8 +536,7 @@
=item B<-vlruinterval <I<seconds>>
-The number of seconds between VLRU candidate queue scan default is 120 s.
-The second s.
+The number of seconds between VLRU candidate queue scan default is 120 seconds.
This option is only supported by the demand-attach file server.

Ah, I see that par did the stupid thing that it does and I didn't notice.
Thanks, will fix.

Post by Steven Jenkins
Also, I thought hard about alphabetizing the options, given that there
are now 50 of them. However, that would break quite a bit of the
logical flow: currently, most options are grouped with similar ones.
Certainly if there are strong opinions, we can do something else with
the ordering.

I think we should have fewer options. :)

[Jeffrey Altman]

Post by Russ Allbery

Post by Steven Jenkins
Also, I thought hard about alphabetizing the options, given that there
are now 50 of them. However, that would break quite a bit of the
logical flow: currently, most options are grouped with similar ones.
Certainly if there are strong opinions, we can do something else with
the ordering.

I think we should have fewer options. :)

I would be supportive of a patch to support the use of configuration
files instead of command line options.

Jeffrey Altman