[OpenAFS-Doc] Re: [Fwd: documentation patches]

[Russ Allbery]

Hi,
Get your fresh, hot patches!!
New man pages: pod1/fs_setcrypt, pod1/fs_getcrypt, pod5/CellAlias

Thanks! Committed with some editing. A few notes:

* Cross-references to man pages should be in the form:

L<page(1)>,
L<other-page(8)>,
L<something(5)>

Note the commas and the lack of blank lines between the references so
that they're wrapped together on one line in the man page output.

* Flags should be given with B<-flag> when defined or referenced or as
C<-flag> when talking about an example of what someone would type. See
the pod2man man page for details on style here.

* Use three spaces of indentation for verbatim text, such as in examples.

* In examples, put "% " before commands the user types.

Overall, this looks really good. I'm starting on your other man pages
now.

[Jason Edgecombe]

Post by Russ Allbery

Hi,
Get your fresh, hot patches!!
New man pages: pod1/fs_setcrypt, pod1/fs_getcrypt, pod5/CellAlias

L<page(1)>,
L<other-page(8)>,
L<something(5)>
Note the commas and the lack of blank lines between the references so
that they're wrapped together on one line in the man page output.
* Flags should be given with B<-flag> when defined or referenced or as
C<-flag> when talking about an example of what someone would type. See
the pod2man man page for details on style here.
* Use three spaces of indentation for verbatim text, such as in examples.
* In examples, put "% " before commands the user types.
Overall, this looks really good. I'm starting on your other man pages
now.

You're welcome. I'm glad to help. I think OpenAFS rocks, and I really
want to see it succeed! World domination is the ultimate goal. All other
network filesystems will kneel before OpenAFS.... ;)

As I see it, OpenAFS is no more complicated than other similar products.
I think that excellent documentation is the biggest deficiency.

I admit that seeing my name on the man pages boosts my ego, but that's a
side benefit.

Thanks for the tips on style and content. I hope to contribute more in
the future.

Sincerely,
Jason

[ted creedon]

Is this now in cvs? If so where?

thanks

-----Original Message-----
From: openafs-doc-***@openafs.org [mailto:openafs-doc-***@openafs.org]
On Behalf Of Russ Allbery
Sent: Sunday, August 05, 2007 2:08 PM
To: Jason Edgecombe
Cc: openafs-***@openafs.org
Subject: [OpenAFS-Doc] Re: [Fwd: documentation patches]

Hi,
Get your fresh, hot patches!!
New man pages: pod1/fs_setcrypt, pod1/fs_getcrypt, pod5/CellAlias

Thanks! Committed with some editing. A few notes:

* Cross-references to man pages should be in the form:

L<page(1)>,
L<other-page(8)>,
L<something(5)>

Note the commas and the lack of blank lines between the references so
that they're wrapped together on one line in the man page output.

* Flags should be given with B<-flag> when defined or referenced or as
C<-flag> when talking about an example of what someone would type. See
the pod2man man page for details on style here.

* Use three spaces of indentation for verbatim text, such as in examples.

* In examples, put "% " before commands the user types.

Overall, this looks really good. I'm starting on your other man pages
now.

[Christopher D. Clausen]

Post by ted creedon
Is this now in cvs? If so where?

They seems to be in openafs/doc/man-pages/fs*.pod, at least in the
default branch. Hopefully the changes will be added to the stable_1_4_x
branch as well.

<<CDC

[Russ Allbery]

Post by Christopher D. Clausen
They seems to be in openafs/doc/man-pages/fs*.pod, at least in the
default branch. Hopefully the changes will be added to the stable_1_4_x
branch as well.

They've all been pulled up.

[Jason Edgecombe]

Post by Christopher D. Clausen

Post by ted creedon
Is this now in cvs? If so where?

They seems to be in openafs/doc/man-pages/fs*.pod, at least in the
default branch. Hopefully the changes will be added to the stable_1_4_x
branch as well.
<<CDC

It's in cvs in openafs/doc/man-pages/pod1/fs_getcrypt.pod

See http://www.openafs.org/cgi-bin/cvsweb.cgi/openafs/doc/man-pages/pod1/

some commands are in pod5 and pod8 as well. It's in the stable 1.4.x branch


Jason