caml-list - the Caml user's mailing list
 help / color / mirror / Atom feed
From: Pietro Abate <Pietro.Abate@pps.jussieu.fr>
To: caml-list@inria.fr
Subject: Re: [Caml-list] ocamlbuild, ocamldoc and module packs
Date: Fri, 11 Nov 2011 14:08:47 +0100	[thread overview]
Message-ID: <20111111130847.GA10832@pps.jussieu.fr> (raw)
In-Reply-To: <20111110205259.GZ3413@localhost>

Hello.

As far as I know ocamldoc doesn't play very well with -pack. There is 
a very old bug on mantis about this.

I'm in a situation that is worst then yours where I use pack to hide
modules with the same name as in ModuleOne/A and ModuleTwo/A and
ocamldoc refuses altogether to generate doc for both modules.  I've not
found a solution neither for my problem, or more in general for the one
you describe below.

I think the good ppl that put Batteries together had similar issues.

If you look at the Batteries source there is a lot of code aimed at
solving this problem by effectively creating new source files that can
be properly digested by ocamldoc. For what I gathered is pretty specific
to their case, but probably you can use it as an example to write an
appropriate ocamldoc plugin.

Maybe the recent release of Argot by XC solves some of these problem
(just a wild guess, I didn't look at it very carefully).

Hope this helps.

p

On Thu, Nov 10, 2011 at 09:52:59PM +0100, Guillaume Yziquel wrote:
> Hi.
> 
> I've been trying recently to use ocamldoc with ocamlbuild on module
> packs.
> 
> I have a prog.odocl file containing things like
> 
> 	ModuleOne/A
> 	ModuleOne/B
> 	ModuleTwo/C
> 	ModuleTwo/D
> 
> and the ocamldoc documentation has at its root the module A, B, C and D.
> Not ModuleOne and ModuleTwo.
> 
> Replacing prog.odocl naively by
> 
> 	ModuleOne
> 	ModuleTwo
> 
> fails with a rather verbose ocamldoc solver error.
> 
> My _tags file contains something like:
> 
> 	<ModuleOne/*.cmx> : for-pack(ModuleOne)
> 	<ModuleTwo/*.cmx> : for-pack(ModuleTwo)
> 
> Is there any way to make ocamldoc behave more nicely with respect to
> module packs (if possible via ocamlbuild)?
> 
> -- 
>      Guillaume Yziquel
> 
> -- 
> Caml-list mailing list.  Subscription management and archives:
> https://sympa-roc.inria.fr/wws/info/caml-list
> Beginner's list: http://groups.yahoo.com/group/ocaml_beginners
> Bug reports: http://caml.inria.fr/bin/caml-bugs

-- 
----
http://en.wikipedia.org/wiki/Posting_style

  reply	other threads:[~2011-11-11 13:08 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-11-10 20:52 Guillaume Yziquel
2011-11-11 13:08 ` Pietro Abate [this message]
2011-11-12  8:35   ` Guillaume Yziquel

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20111111130847.GA10832@pps.jussieu.fr \
    --to=pietro.abate@pps.jussieu.fr \
    --cc=caml-list@inria.fr \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).