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

Re: [was: generation of ocamldoc HTML documentation for libs (via cdbs)] OCaml policy for documentation



On Mon, Aug 27, 2007 at 08:04:56AM +0000, Sylvain Le Gall wrote:
> If upstream generate anything using another way, lets go for it. I
> think that each -dev package must have
> /usr/share/doc/PACKAGE/html/api/ (can be a link).

Agreed, I like this path. I'm just going to commit the CDBS class patch
which uses that directory.

While I was at it I've also changed the provided variables so that
OCAML_LIBDEV_PACKAGES contains a list of packages matching
libXXX-ocaml-dev and (for consistency) OCAML_LIB_PACKAGES a list of
those matching libXXX-ocaml. The usual line to require ocamldoc
invocation help has now become:

  OCAML_OCAMLDOC_PACKAGES = $(OCAML_LIBDEV_PACKAGES)

I'll also add an appendix in the policy whose purpose is to describe how
to use the CDBS class. For the moment it will be empty, pointing to the
online version of the .mk files, whose comments are quite informative.

Volunteers for fixing the SHOULD/MUST issues in the policy are welcome.

> Yep, something like 3pm (3ml? 3o?) I am not sure if we can freely create
> manpages section. If we decide that there is an interest doing this, we

3o is fine, thanks to Julien for the Pervasives example, here was where
I've read that :-)

> I was thinking of the semantic used in RFC. 
> http://www.ietf.org/rfc/rfc2119.txt
> 
> I.e. this is a policy violation not to have a MUST item (hence people
> can fill non-wishlist bug).

Ok for me then.  I'll try to change the CDBS class so that also manpages
are generated.

> Argh... So we need to stop talking about it before doing it ;-) The

No, sorry, that wasn't my intention. I was just thinking that first of
all it would be good to have more packages shipping API documentation,
better if via a mechanism we can change in a single place affecting all
packages. Once we have widespread adoption of that we can think at
something more ...

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: