[Pkg-ocaml-maint-commits] [SCM] dh-ocaml packaging branch, master, updated. debian/0.9.0-6-g5af8d48

Stefano Zacchiroli zack at upsilon.cc
Tue Oct 6 18:00:36 UTC 2009


The following commit has been merged in the master branch:
commit 5af8d48011ad520a9060f6871b0d6f995b049c0e
Author: Stefano Zacchiroli <zack at upsilon.cc>
Date:   Tue Oct 6 19:59:54 2009 +0200

    dh_ocamldoc manpage improvements
    
    - mention how ocamlfind is detected
    - mention that order is relevant when shipping doc elsewhere

diff --git a/debhelper/dh_ocamldoc b/debhelper/dh_ocamldoc
index 25b3a35..11b7a53 100755
--- a/debhelper/dh_ocamldoc
+++ b/debhelper/dh_ocamldoc
@@ -1,4 +1,4 @@
-#!/usr/bin/perl -w
+j#!/usr/bin/perl -w
 
 # Copyright © 2009 Mehdi Dogguy <mehdi at dogguy.org>
 #
@@ -39,14 +39,19 @@ all the .mli files (or .ml if there is no matching .mli) found in
 debian/package/usr/lib/ocaml.
 
 You can have several flags per line. Lines beginning with "--include"
-have a special meaning: whatever follows "--include" will be
-considered as a list of directories where .mli or .ml files will be
-searched for the documentation generation. The directories will also
-be added to ocamldoc library search path. This can be useful for
-generating the documentation in its own binary package.
-
-dh_ocamldoc detects automatically if "ocamlfind ocamldoc" should be called
-instead of plain "ocamldoc". Lines starting with "#" are comments.
+have a special meaning: whatever follows "--include" will be considered
+as a list of directories where .mli or .ml files will be searched for
+the documentation generation. The directories will also be added to
+ocamldoc library search path. This can be useful for generating the
+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.
+
+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.).
+
+Lines starting with "#" in *ocamldoc files are comments and hence ignored.
 
 =head1 OPTIONS
 
diff --git a/debian/changelog b/debian/changelog
index e123427..f20d445 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -10,6 +10,10 @@ dh-ocaml (0.9.1) UNRELEASED; urgency=low
     to 0 to desactivate dh_ocaml.
   * ocaml-md5sums: Print object file's name when failing
 
+  [ Stefano Zacchiroli ]
+  * dh_ocamldoc manpage improvements: mention how ocamlfind is detected
+    and that order is relevant when shipping doc elsewhere
+
  -- Mehdi Dogguy <mehdi at debian.org>  Tue, 06 Oct 2009 17:17:24 +0200
 
 dh-ocaml (0.9.0) unstable; urgency=low

-- 
dh-ocaml packaging



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