From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.1.3 (2006-06-01) on yquem.inria.fr X-Spam-Level: * X-Spam-Status: No, score=1.2 required=5.0 tests=AWL,SPF_SOFTFAIL autolearn=disabled version=3.1.3 Received: from mail4-relais-sop.national.inria.fr (mail4-relais-sop.national.inria.fr [192.134.164.105]) by yquem.inria.fr (Postfix) with ESMTP id 2C9C0BC69 for ; Wed, 21 Nov 2007 17:01:48 +0100 (CET) X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: Ao8CAEblQ0fAI/YJ/2dsb2JhbAA X-IronPort-AV: E=Sophos;i="4.21,447,1188770400"; d="scan'208";a="19540758" Received: from unknown (HELO bart.inescn.pt) ([192.35.246.9]) by mail4-smtp-sop.national.inria.fr with ESMTP; 21 Nov 2007 17:01:47 +0100 Received: from localhost (bart.inescn.pt [127.0.0.1]) by bart.inescn.pt (8.13.8/8.13.8/1) with ESMTP id lALG1emi013036; Wed, 21 Nov 2007 16:01:40 GMT X-Virus-Scanned: amavisd-new at inescporto.pt Received: from bart.inescn.pt ([127.0.0.1]) by localhost (bart.inescn.pt [127.0.0.1]) (amavisd-new, port 10024) with LMTP id V5WYnP4OI6-a; Wed, 21 Nov 2007 16:01:19 +0000 (WET) Received: from [194.117.30.94] (morfina.inescn.pt [194.117.30.94]) by bart.inescn.pt (8.13.8/8.13.8/38) with ESMTP id lALG0viO013002; Wed, 21 Nov 2007 16:00:57 GMT Message-ID: <47445639.7010600@inescporto.pt> Date: Wed, 21 Nov 2007 16:00:57 +0000 From: Hugo Ferreira User-Agent: Thunderbird 2.0.0.9 (X11/20071119) MIME-Version: 1.0 To: Nicolas Pouillard Cc: caml-list Subject: Re: [Caml-list] ocamlbuild: generating documentation References: <47444388.7020507@inescporto.pt> <1195656845-sup-3339@port-ext2.ensta.fr> In-Reply-To: <1195656845-sup-3339@port-ext2.ensta.fr> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit X-Spam: no; 0.00; mli:01 ocaml-:01 mli:01 cvs:01 ocamldoc:01 -pack:01 wrote:01 compile:01 caml-list:01 interfaces:01 behaviour:01 mly:01 modules:02 modules:02 module:03 Hi, Nicolas Pouillard wrote: > Excerpts from hmf's message of Wed Nov 21 15:41:12 +0100 2007: >> Hello, > Hello, > >> I am attempting to use the document generation option provided by >> ocamlbuild. The manual states that ocamlbuild will "collect all the >> documentation for the interfaces (which will be built if necessary"). >> >> Questions: >> 1. How can I change this so that both *.ml and *.mli file are be used? > > If I well remember in OCaml-3.10.0 only mli files are took in account. Yes, my tests shows this. > In the CVS version ml files are used when no mli can be built. > What do you mean "can't be built"? I assume you can always generate a *.mli given *.ml, correct? Are you referring to other types of sources such as *.mly? Can the behaviour be changed? If I am not mistaken ocamldoc can merge *.ml and *.mli files so I think it may be easy enough to allow this. >> 2. Must I compile the files prior to invoking "ocamlbuild >> all.docdir/index.html" at any point? > > No it must works nicely without any pre-compilation. > Ok. >> On a different issue, the manual refers to "packing subdirectories >> into modules"... >> >> 1. Are we talking about indicating a path here, for example: >> >> cat all.odocl >> src/mod/Mod >> >> So that Mod is documented? > > No it's not related. > > Packing subdirectories is about using -pack to nest modules into one big > module. The "subdirectories" here is perhaps misleading but that's because > most of the time packages are used to reflect the directory hierarchy into > modules. > Ok. Understood. Thank you for such prompt replies. Regards, Hugo F.