← Back to branch summary

~ubuntu-branches/ubuntu/raring/dh-ocaml/raring-proposed

« back to all changes in this revision

Viewing changes to policy/appendix-cdbs.xml

  • Committer: Bazaar Package Importer
  • Author(s): Ralf Treinen, Stéphane Glondu, Ralf Treinen
  • Date: 2010-09-06 20:30:15 UTC
  • mfrom: (1.1.7 sid)
  • Revision ID: james.westby@ubuntu.com-20100906203015-5o9irkfc3yl26tg0
Tags: 0.9.6
http://bugs.debian.org/588371
http://bugs.debian.org/591555
http://bugs.debian.org/591556
http://bugs.debian.org/500286
[ Stéphane Glondu ]
* debian/control:
  - add git-core to Suggests
  - bump Standards-Version to 3.9.1 (no changes)
* tools/:
  - dom-new-git-repo: explicitly use sh when executing remote commands
    via ssh (Closes: #588371)
  - dom-git-checkout: check for existence of upstream/pristine-tar
    remote branches before creating local ones (Closes: #591555)

[ Ralf Treinen ]
* policy/: continue work started by Sylvain Le Gall on splitting the 
  document into policy and reference (thanks, Sylvain!):
  - current value of ocaml version no longer mentionend in policy
  - fix location of library directory (closes: #591556)
  - refactor sections, many small changes all over the document
  - streamline discussion on bytecode vs native code
  - compiling with -custom is deprecated (closes: #500286)
  - reference: add section on dh
  - findlib integration: META files always go in the directory of the
    library, debian-specific ones should have a comment.
* Makefile: generate the reference document
* update authors in doc-base registration for the policy
* add doc-base registration for the reference.
* Added myself to uploaders.

Show diffs side-by-side

added added

removed removed

Lines of Context:
policy/appendix-cdbs.xml
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
3
 
 "/usr/share/sgml/docbook/dtd/xml/4.3/docbookx.dtd" [
4
 
<!ENTITY % included SYSTEM "included.ent">
5
 
%included;
6
 
]>
7
 
<appendix>
8
 
  <title>The OCaml CDBS class</title>
9
 
  <para>
10
 
    To help maintainers of OCaml-related packages in adhering to this policy, a
11
 
    class for the <ulink url="http://build-common.alioth.debian.org/">CDBS
12
 
      build system</ulink> has been made available and is shipped as part of
13
 
    the <filename>ocaml-nox</filename> package. Please consider using it in your
14
 
    packages at it will both ease your work and permit to perform changes to a
15
 
    wide range of packages acting on a single piece of software (the CDBS class
16
 
    itself).
17
 
  </para>
18
 
 
19
 
  <para>
20
 
    To use the class in your package it is enough to include the file
21
 
    <filename>/usr/share/cdbs/1/rules/ocaml.mk</filename> from your
22
 
    <filename>debian/rules</filename>. If you use debhelper (please do) you
23
 
    should include the OCaml class after the debhelper on. A typical
24
 
    <filename>debian/rules</filename> heading for a package using plain Makefile
25
 
    (i.e. no autotools) and dpatch is as follows:
26
 
    <programlisting>
27
 
  #!/usr/bin/make -f
28
 
  include /usr/share/cdbs/1/rules/dpatch.mk
29
 
  include /usr/share/cdbs/1/rules/debhelper.mk
30
 
  include /usr/share/cdbs/1/class/makefile.mk
31
 
  include /usr/share/cdbs/1/rules/ocaml.mk
32
 
    </programlisting>
33
 
    For an example of such a package see the <filename>pcre-ocaml</filename>
34
 
    Debian source package.
35
 
  </para>
36
 
 
37
 
  <para>
38
 
    A detailed description of how to use the OCaml CDBS class should be provided
39
 
    in this section, but at the time of writing is a future work :-). In the
40
 
    meantime if you know CDBS, the .mk files which compose the OCaml
41
 
    class are well commented and they should give you enough information to
42
 
    customize the build process of your package. The latest version of them is
43
 
    available in the repository of the &ocaml-force; and can be browsed on the
44
 
    web:
45
 
    <variablelist>
46
 
 
47
 
      <varlistentry>
48
 
        <term><filename><ulink url="http://git.debian.org/?p=pkg-ocaml-maint/packages/ocaml.git;a=blob;f=debian/cdbs/ocaml-vars.mk;hb=HEAD">ocaml-vars.mk</ulink></filename></term>
49
 
        <listitem>
50
 
          <para>
51
 
            contains (Makefile) convenience variables which can be used in
52
 
            <filename>debian/rules</filename>
53
 
          </para>
54
 
        </listitem>
55
 
      </varlistentry>
56
 
        
57
 
      <varlistentry>
58
 
        <term><filename><ulink url="http://git.debian.org/?p=pkg-ocaml-maint/packages/ocaml.git;a=blob;f=debian/cdbs/ocaml.mk;hb=HEAD">ocaml.mk</ulink></filename></term>
59
 
        <listitem>
60
 
          <para>
61
 
            implements the class logic
62
 
          </para>
63
 
        </listitem>
64
 
      </varlistentry>
65
 
        
66
 
    </variablelist>
67
 
  </para>
68
 
</appendix>