.pod files and how they should be written...

[Richard Levitte - VMS Whacker]

Looking around in the current .pod files, I see a number of styles and
som things I do not understand or agree with, and I'm starting to feel
like we should try to agree on some kind of common ground so we don't
get in a mess of shoving text back and forth or something like that (I
plead guilty!).

There's one thing that I started nibbling a little on in BIO_s_fd.pod
and BIO_s_file.pod: I believe that things that aren't strictly
descriptions of the functions listed in the SYNOPSIS do not belong in
the DESCRIPTION and should be moved to NOTES.  That's what I did in
those two files, and then I got into some doubts, so I'd like to hear
what others think (especially the rest of the development team).

Comments?

I'm running through the .pod files a little now and then to see if I
can find some inconsistencies or things that are confusing, just to
make sure.

-- 
Richard Levitte   \ Spannv�gen 38, II \ [EMAIL PROTECTED]
Chairman@Stacken   \ S-168 35  BROMMA  \ T: +46-8-26 52 47
Redakteur@Stacken   \      SWEDEN       \ or +46-709-50 36 10
Procurator Odiosus Ex Infernis                -- [EMAIL PROTECTED]
Member of the OpenSSL development team: http://www.openssl.org/
Software Engineer, Celo Communications: http://www.celocom.com/

Unsolicited commercial email is subject to an archival fee of $400.
See <http://www.stacken.kth.se/~levitte/mail/> for more info.
______________________________________________________________________
OpenSSL Project                                 http://www.openssl.org
Development Mailing List                       [EMAIL PROTECTED]
Automated List Manager                           [EMAIL PROTECTED]