[Pkg-ocaml-maint-commits] [SCM] dh-ocaml packaging branch, master, updated. debian/0.9.3-3-g685cc47

Mehdi Dogguy mehdi at debian.org
Fri Nov 13 10:25:01 UTC 2009


The following commit has been merged in the master branch:
commit 685cc478d03c0dc0144a00056652d59ce131267a
Author: Mehdi Dogguy <mehdi at debian.org>
Date:   Fri Nov 13 11:24:47 2009 +0100

    dh_ocamldoc: Add some bits to the manpage about how to deal with several documentations.

diff --git a/debhelper/dh_ocamldoc b/debhelper/dh_ocamldoc
index a70508f..6719606 100755
--- a/debhelper/dh_ocamldoc
+++ b/debhelper/dh_ocamldoc
@@ -33,10 +33,12 @@ B<dh_ocamldoc> [S<I<debhelper options>>]
 
 =head1 DESCRIPTION
 
-dh_ocamldoc looks for debian/package.ocamldoc files where it can find
-the flags that will be given to ocamldoc, which will be called with
+dh_ocamldoc looks for all files matching "debian/$package.ocamldoc*" where it
+can find the flags that will be given to ocamldoc, which will be called with
 all the .mli files (or .ml if there is no matching .mli) found in
-debian/package/usr/lib/ocaml.
+debian/package/usr/lib/ocaml. Each ".ocamldoc*" file is used to generate a
+different documentation where the part coming after "ocamldoc" in the filename
+is used as document ID in the doc-base file.
 
 You can have several flags per line. Lines beginning with "--include"
 have a special meaning: whatever follows "--include" will be considered
@@ -47,6 +49,10 @@ documentation in its own binary package. Note that, to that end, you
 should ensure that the package shipping the documentation is treated by
 dh_ocamldoc after the package shipping the actual objects.
 
+The "-d" flag is detected and used to generate the appropriate doc-base file.
+It contains the path of the documentation directory and is relative to
+"/usr/share/doc/$package/". The default value is "html/api".
+
 dh_ocamldoc detects automatically if "ocamlfind ocamldoc" should be
 called instead of plain "ocamldoc" (it does so by looking for common
 ocamlfind options such as: -package, -predicates, etc.).
diff --git a/debian/changelog b/debian/changelog
index 80765fc..a4d745a 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -2,8 +2,10 @@ dh-ocaml (0.9.4) unstable; urgency=low
 
   * dh_ocamldoc: Use word boundaries to correctly detect ocamlfind options
     instead of spaces (Closes: #555794).
+  * dh_ocamldoc: Add some bits to the manpage about how to deal with
+    several documentations.
 
- -- Mehdi Dogguy <mehdi at debian.org>  Wed, 11 Nov 2009 22:19:22 +0100
+ -- Mehdi Dogguy <mehdi at debian.org>  Fri, 13 Nov 2009 11:08:22 +0100
 
 dh-ocaml (0.9.3) unstable; urgency=low
 

-- 
dh-ocaml packaging



More information about the Pkg-ocaml-maint-commits mailing list