[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: browsing ocamldoc generated documentation



On Mon, Sep 03, 2007 at 06:12:43PM +0200, Stefano Zacchiroli wrote:
> > Also, I don't see the need for the verbose names.  What's wrong
> > with the current <PACKAGENAME> entry in /usr/share/doc-base?
>
> That you don't know how to recognize that they are actually ocamldoc
> generated API references. Also remember that a package can ship more
> than one doc-base entries, findlib is an example of such a package.
> With a naming convention I manage to distinguish the one I'm interested
> in.

Let me add a couple more info about that. First of all the verbose name
"PKGNAME-ocamldoc-api-reference" is only the internal unique id used by
doc-base, AFAIK the users never see it (except if they dig manually in
/usr/share/doc-base/ of course).

The rationale for the various parts is that "ocamldoc" is to identify
that the doc has been generated automatically, after all a package can
even ship an API reference made in some other non automatic ways (or
automatic but not based on ocamldoc).

Cheers.

-- 
Stefano Zacchiroli -*- PhD in Computer Science ............... now what?
zack@{cs.unibo.it,debian.org,bononia.it} -%- http://www.bononia.it/zack/
(15:56:48)  Zack: e la demo dema ?    /\    All one has to do is hit the
(15:57:15)  Bac: no, la demo scema    \/    right keys at the right time

Attachment: signature.asc
Description: Digital signature


Reply to: