From: Stefano Zacchiroli <zack@debian.org>
Date: Mon, 27 Aug 2007 08:58:37 +0000 (+0000)
Subject: * Policy
X-Git-Tag: archive/raspbian/4.08.1-4+rpi1~3^2~545
X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=ad7d8d17753249fbec69eb3dccc063fddda6cdd8;p=ocaml.git

* Policy
  - add an appendix about the CDBS class with some minimal information and
    pointers to the commented .mk files
---

diff --git a/debian/changelog b/debian/changelog
index d37e4b5f..bf965a69 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -5,8 +5,11 @@ ocaml (3.10.0-6) UNRELEASED; urgency=low
     - avoid creating empty /usr/include/ocaml/* directory (closes: #439017)
   * CDBS class
     - add support for automatic ocamldoc HTML documentation generation
+  * Policy
+    - add an appendix about the CDBS class with some minimal information and
+      pointers to the commented .mk files
 
- -- Stefano Zacchiroli <zack@debian.org>  Sat, 25 Aug 2007 20:28:29 +0200
+ -- Stefano Zacchiroli <zack@debian.org>  Mon, 27 Aug 2007 10:56:28 +0200
 
 ocaml (3.10.0-5) experimental; urgency=low
 
diff --git a/debian/policy/appendix-cdbs.xml b/debian/policy/appendix-cdbs.xml
new file mode 100644
index 00000000..91536e4e
--- /dev/null
+++ b/debian/policy/appendix-cdbs.xml
@@ -0,0 +1,59 @@
+<para>
+  To help maintainers of OCaml-related packages in adhering to this policy, a
+  class for the <ulink url="http://build-common.alioth.debian.org/">CDBS
+    build system</ulink> has been made available and is shipped as part of
+  the <filename>ocaml-nox</filename> package. Please consider using it in your
+  packages at it will both ease your work and permit to perform changes to a
+  wide range of packages acting on a single piece of software (the CDBS class
+  itself).
+</para>
+
+<para>
+  To use the class in your package it is enough to include the file
+  <filename>/usr/share/cdbs/1/class/ocaml.mk</filename> from your
+  <filename>debian/rules</filename>. If you use debhelper (please do) you
+  should include the OCaml class after the debhelper on. A typical
+  <filename>debian/rules</filename> heading for a package using plain Makefile
+  (i.e. no autotools) and dpatch is as follows:
+  <programlisting>
+#!/usr/bin/make -f
+include /usr/share/cdbs/1/rules/debhelper.mk
+include /usr/share/cdbs/1/class/makefile.mk
+include /usr/share/cdbs/1/class/ocaml.mk
+include /usr/share/cdbs/1/rules/dpatch.mk
+  </programlisting>
+  For an example of such a package see the <filename>pcre-ocaml</filename>
+  Debian source package.
+</para>
+
+<para>
+  A detailed description of how to use the OCaml CDBS class should be provided
+  in this section, but at the time of writing is a future work :-). In the
+  meantime if you know CDBS, the .mk files which compose the OCaml
+  class are well commented and they should give you enough information to
+  customize the build process of your package. The latest version of them is
+  available in the repository of the &ocaml-force; and can be browsed on the
+  web:
+  <variablelist>
+
+    <varlistentry>
+      <term><filename><ulink url="http://svn.debian.org/wsvn/pkg-ocaml-maint/trunk/packages/ocaml/trunk/debian/cdbs/ocaml-vars.mk?op=file&amp;rev=0&amp;sc=0">ocaml-vars.mk</ulink></filename></term>
+      <listitem>
+	<para>
+	  contains (Makefile) convenience variables which can be used in
+	  <filename>debian/rules</filename>
+	</para>
+      </listitem>
+    </varlistentry>
+      
+    <varlistentry>
+      <term><filename><ulink url="http://svn.debian.org/wsvn/pkg-ocaml-maint/trunk/packages/ocaml/trunk/debian/cdbs/ocaml.mk?op=file&amp;rev=0&amp;sc=0">ocaml.mk</ulink></filename></term>
+      <listitem>
+	<para>
+	  implements the class logic
+	</para>
+      </listitem>
+    </varlistentry>
+      
+  </variablelist>
+</para>
diff --git a/debian/policy/ocaml_packaging_policy.xml b/debian/policy/ocaml_packaging_policy.xml
index 08e5149a..0b0bd393 100644
--- a/debian/policy/ocaml_packaging_policy.xml
+++ b/debian/policy/ocaml_packaging_policy.xml
@@ -27,6 +27,7 @@
 <!ENTITY chapter-libpack     SYSTEM "chapter-libpack.xml">
 <!ENTITY chapter-progpack    SYSTEM "chapter-progpack.xml">
 <!ENTITY chapter-liblocal    SYSTEM "chapter-liblocal.xml">
+<!ENTITY appendix-cdbs       SYSTEM "appendix-cdbs.xml">
 <!ENTITY appendix-resources  SYSTEM "appendix-resources.xml">
 <!ENTITY appendix-svn        SYSTEM "appendix-svn.xml">
 ]>
@@ -53,6 +54,11 @@
         &chapter-libpack;
     </chapter>
 
+    <appendix id="cdbs">
+        <title>The OCaml CDBS class</title>
+        &appendix-cdbs;
+    </appendix>
+
     <appendix id="resources">
         <title>&ocaml-force; resources</title>
         &appendix-resources;