> deraadt> These are function-describing manual pages which have a name,
> deraadt> but that name is not the function they export.
> 
> True, they export the concept that is implemented by those functions.
> If you nkow a better way to put a concept into a man page, please tell
> us.

Simple.  Make sure man pages for functions are named by their
functions, and only by their functions.  When you Xr, do so towards
the functions.

> deraadt> This is manual page system pollution.  I do not want to
> deraadt> install a threads(3) man page.  I do not want to install a
> deraadt> err(3) man page either, since we already have one in our
> deraadt> system, and err() is a real function libc exports.
> deraadt> 
> deraadt> For instance, rc4.pod says:
> deraadt> 
> deraadt>         void RC4_set_key(RC4_KEY *key, int len, const unsigned char *data);
> deraadt> 
> deraadt>         void RC4(RC4_KEY *key, unsigned long len, const unsigned char 
>*indata,
> deraadt>                  unsigned char *outdata);
> deraadt> 
> deraadt> I would prefer if the file in question called RC4_set_key.pod or
> deraadt> RC4.pod; and in either case things can cross-reference easily to
> deraadt> those.
> deraadt> 
> deraadt> If someone wants to work with me on this, please get in touch.
> 
> There's another variant that was proposed here, but hasn't yet been
> implemented, and it's that the section wouldn't just be a number.
> Instead, something like 1ssl, 3ssl, 5ssl and 7ssl would be used.  The
> result is that you'd get a threads(3ssl), err(3ssl), passwd(1ssl),
> rc4(3ssl).
> 
> How does that sonud to you?

Not good.  In the end, it is still more difficult for people to search for
those manual pages.
______________________________________________________________________
OpenSSL Project                                 http://www.openssl.org
Development Mailing List                       [EMAIL PROTECTED]
Automated List Manager                           [EMAIL PROTECTED]

Reply via email to