Hi!

On Thu, Feb 03, 2022 at 08:04:49AM +0000, Julien ÉLIE wrote:
> > As of now, libinn2-dev ships list.3 with an inn2-specific list
> > implementation. However, Linux man-pages ships list.3 that documents
> > sys/queue.h, a popular, if obscure, double-linked list implementation
> > available on all modern BSDs.
> >
> > See patch below, which just re-names the file to list-inn2.3
> 
> This is a good point.  I think we should  thenhomogenize the name
> of all our library man pages.
> As the routines described in list(3) are built in libinn(3), I suggest
> prefixing all of them with "libinn_".  This way we would have:
> libinn_clientlib(3)
> libinn_dbz(3)
> libinn_inndcomm(3)
> libinn_list(3)
> libinn_qio(3)
> libinn_tst(3)
> libinn_uwildmat(3)

The consistency here is much nicer than my minimum-viable solution,
yeah :)

> along with untouched:
> libinn(3)
> libauth(3)
> libinnhist(3)
> libstorage(3)
> 
> Though maybe we should also rename libauth(3) and libstorage(3)
> man pages to libinnauth(3) and libinnstorage(3)?
> And of course also generate libinnauth.so and libinnstorage.so
> instead of libauth.so and libstorage.so, to be consistent.

That's less of an issue since these don't conflict with anything,
but if you've already got an ABI break coming then it'd be much nicer
from a namespacing/usage perspective, agreed.

> If that looks OK, prefixing with "libinn_" could be done in the
> upcoming INN 2.6.5 release (in a few days/weeks),

In that case, the next release of man-pages should (semi-, there's a
script that picks up the file list from sid, but the maintainer doesn't
seem to always run it? but they will this time to close #951598)
automatically include list.3.

Thanks,
наб

Attachment: signature.asc
Description: PGP signature

Reply via email to