From: Samuel Mimram Date: Fri, 16 Jun 2006 08:33:18 +0000 (+0000) Subject: Integrate the packaging policy to the package. X-Git-Tag: archive/raspbian/4.08.1-4+rpi1~3^2~641^2 X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=0ca7f0d70d66de72e9b15f54237e4259c2235e5f;p=ocaml.git Integrate the packaging policy to the package. --- diff --git a/Makefile b/Makefile deleted file mode 100644 index 05f3a7fb..00000000 --- a/Makefile +++ /dev/null @@ -1,12 +0,0 @@ -all: html text - -html: - docbook2html ocaml_packaging_policy.xml -o packaging-policy-html - -text: - docbook2txt ocaml_packaging_policy.xml - -clean: - $(RM) -rf packaging-policy-html ocaml_packaging_policy.txt - -.PHONY: html text diff --git a/README b/README deleted file mode 100644 index 64b5e6de..00000000 --- a/README +++ /dev/null @@ -1,20 +0,0 @@ ------------------------ -* * -* HOWTO-XML * -* DOCBOOK * -* * -* * ------------------------ - - -If you are interested in writing in the policy, you should -take a look at - -http://docbook.sourceforge.net/ -http://www.oasis-open.org/docbook/documentation/reference/html/docbook.html - -When you finish write your part, just do a make clean && make all. It will result -in having ocaml_packaging_policy.html... - -Sylvain LE GALL -Sat, 18 October 2003 diff --git a/appendix-resources.xml b/appendix-resources.xml deleted file mode 100644 index aea329b3..00000000 --- a/appendix-resources.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - &ocaml-force;'s website: http://pkg-ocaml-maint.alioth.debian.org/ (it's an Alioth project) - &ocaml-force;'s mailing list: debian-ocaml-maint@lists.debian.org (archives) - - diff --git a/appendix-svn.xml b/appendix-svn.xml deleted file mode 100644 index a40a681f..00000000 --- a/appendix-svn.xml +++ /dev/null @@ -1,229 +0,0 @@ -
- How to obtain a copy of the SVN archive - - You can obtain a copy of debian-ocaml-maint SVN archive by - -svn co svn+ssh://svn.debian.org/svn/pkg-ocaml-maint - - You must be member of the - Debian - OCaml Task Force in order to have write access to this archive. - -
- -
- Structure of the SVN archive - - We keep all files of the debian subdirectory under svn control, and - upstream only as a compressed tarball. The rationale behind this is - that changes to upstream files should be managed by the dpatch patch - manager. Hence, all the diffs to upstream files are kept in a - subdirectory of debian/, and it is not necessary to manage upstream on - file-by-file basis. - - - - The structure of the pkg-ocaml-maint svn archive is as follows, where - generic names are indicated in square brackets [ .. ], and where the - contents of subdirectories not directly relevant for package management - are not detailed: - - tags - packages - [package1] - [version1] - [version2] - ... - [package2] - [version1] - ... - ... - projects - test - trunk - packages - [package1] - trunk - debian - upstream - [upstream-tarball-version1] - [upstream-tarball-version2] - ... - [package2] - ... - policy - projects - tools - - -
- -
- How to add a new package to the SVN archive - - Place yourself in the directory trunk/packages of your working copy of - the svn repository. Create a directory with the same name as your - source package (let's say, my-package), and subdirectories upstream - and trunk. Put the current upstream tarball in upstream, and the - current debian directory with all its relevant files in trunk. This - should now look like this: - - trunk/packages/my_package - upstream - my_package_1.2.3.orig.tar.gz - trunk - debian - changelog - control - copyright - patches - 00_list - 01_patch1.dpatch - ... - ... - - - - - If everything is in order you can do a svn add my_package from the trunk/packages directory, and eventually svn commit. - -
- -
- How to set up your package for use with <application>svn-buildpackage</application> - - - Please see the svn-buildpackage documentation for complete - information. The important issues here are: - - - - Since we keep upstream as a tarball we have to use svn-buildpackage in - so-called merge mode. This means that, before compiling the package, - the debianized source tree is constructed by untarring the orig tarball, and then merging the contents of the trunk subdirectory in it. - - - - - The structure of our svn repository is not among the default structures - of svn-buildpackage. Hence, we have to override the default location of some - directories. - - - - - - - Place yourself in trunk/packages/my_packages/trunk, and do the following: - svn propset mergeWithUpstream 1 debian. - This registers the property "mergeWithUpstream" with the current - directory, such that svn-buildpackage knows that it has to use merge - mode as explained above. - - - - Create a file debian/svn-deblayout with the following contents: - -origDir=../upstream -origUrl=svn+ssh://svn.debian.org/svn/pkg-ocaml-maint/trunk/packages/my_package/upstream -tagsUrl=svn+ssh://svn.debian.org/svn/pkg-ocaml-maint/tags/packages/my_package - - - - - Remember that "my_package" has to be replaced by the name of your - actual package. svn-buildpackage will not include this file in the - source package when actually building the package. - - - - If you tried svn-buildpackage before writing your debian/svn-deblayout remember - to delete .svn/deb-layout, since svn-buildpackages caches here the content - of svn-deblayout (that would be empty in this case) and will ignore - your debian/svn-deblayout. - -
- -
- How to build a package with <application>svn-buildpackage</application> - - - Please refer to the svn-builpackage documentation for more complete - information. Here is just a quick guide. - - - - All options, except those starting on , are passed to - dpkg-buildpackage. Hence, basic usage should be something like this - (from the trunk/packages/my_package/trunk directory): svn-buildpackage -rfakeroot -uc -us. - - - - svn-buildpackage will complain when your copy of the debian directory - is not in sync with the repository. You may use the option - to override this behaviour. The package will be - build in the directory ../build-area. - - - - If your package is ready for upload you may use the option - for the final build. This will put a tag in the svn-repository on the - current version, and add a new entry in the changlog to start working - on the upcomming next version: svn-buildpackage --svn-tag. - Provided you have commited all your changes to the svn repository, this - will after a successful build of the package create a tag for the current - version in tags/packages/my_package. The tagging is done directly in the - svn repository. - - - - - Some useful aliases took from the svn-buildpackage HOWTO: - -alias svn-b='svn-buildpackage -rfakeroot --svn-dont-clean -us -uc --svn-ignore' -alias svn-bt='svn-buildpackage -rfakeroot --svn-lintian --svn-dont-clean --svn-tag' - - - - - The former (svn-b) is to be used for test builds, while you are - working on your package; while the latter (svn-bt) is to be used at - the end, after you commit your changes and just before uploading a new - version of the package to the debian archive. - - - - Adding -k<your gpg id> to the svn-bt alias may also be useful when working on - collaboratively maintained packages: - -alias svn-bt='svn-buildpackage -rfakeroot -k<gpgid> --svn-lintian --svn-dont-clean --svn-tag' - - - -
- -
- dpatch - - - dpatch will work properly at package build time with the svn - structure described above since all of the build process will be - carried out in a fresh directory. However, invoking - debian/rules with the "clean" target in - the trunk/ directory will fail since - dpatch is unable to de-apply patches. Passing - to - svn-buildpackage fixes this - misbehaviour (aliases suggested above already include this - flag). - - - If you want to use dpatch-edit-patch to handle patches, you will need to invoke - it in "debian only mode" ( flag, see man dpatch-edit-patch) and to tell him - where to find the upstream tarball. Adding the following line to your - ~/.dpatch.conf will be enough: - -conf_origtargzpath=../upstream - - -
diff --git a/authors.xml b/authors.xml deleted file mode 100644 index 26819dd7..00000000 --- a/authors.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - The Debian OCaml Task Force -
debian-ocaml-maint@lists.debian.org
- - diff --git a/chapter-generalities.xml b/chapter-generalities.xml deleted file mode 100644 index db03cc6e..00000000 --- a/chapter-generalities.xml +++ /dev/null @@ -1,149 +0,0 @@ -
- OCaml in Debian - - At the time of this writing, the latest version of OCaml in Debian is &ocaml-version;. - - - - The ocaml package depends on all the basic packages needed to develop programs with OCaml. More specifically, the packaging of OCaml is split into smaller packages. The packages with suffix -nox contain libraries which don't need X (i.e., for the programs which don't use the Graphics or LablTk modules) in order to avoid dependencies on big packages for users who do not need to run graphical applications. Here is the list of binary packages in which OCaml is split: - - - - The ocaml and ocaml-nox packages contain the compiler and its libraries. - - - - - The ocaml-native-compilers package contains the OCaml compilers built in native mode (ocamlc.opt and ocamlopt.opt). - - - The compilers themselves are built in native mode, nonetheless, both compilers for compiling toward bytecode and native code are contained in this package. - - - - - The ocaml-base and ocaml-base-nox packages contain the interpreter and runtime libraries needed by bytecode programs compiled with OCaml (in particular, the package ocaml-base-nox contains the ocamlrun program). - - - - - The ocaml-interp package contains the toplevel system for OCaml (ocaml), that enables interactive use of the language. - - - - - The ocaml-mode package contains the OCaml Emacs mode (the one provided with OCaml, not the tuareg mode which is in the package tuareg-mode). - - - - - The ocaml-source package contains the sources of the OCaml compiler. - - - - - The ocaml-compiler-libs package contains some internal libraries of the OCaml compiler (needed only in very rare cases, e.g. for developing languages which reuse OCaml internals). - - - - - - - Since libraries produced by OCaml are binary incompatible when compiled with different releases of OCaml, versioned virtual packages are also provided by packages at items (1) and (2): ocaml-&ocaml-version;, ocaml-nox-&ocaml-version;, ocaml-base-&ocaml-version;, ocaml-base-nox-&ocaml-version;. - - -
- OCaml location - - The root of all installed OCaml libraries is the OCaml - standard library directory, which is - /usr/lib/ocaml/VERSION/, at the time of writing - &ocaml-sys-dir;. It can be output - by the OCaml compiler invoking it as ocamlc -where. - - -
- -
- -
- Bytecode and native programs - - - The OCaml compiler can produce two kinds of executables: bytecode and native. The native executables (compiled with ocamlopt) are generally faster since they are compiled specifically for an achitecture. The bytecode executables (compiled with ocamlc) have the advantage of being portable, which means that a bytecode program can be run on any achitecture without needing to be rebuilt. It should be noted that native OCaml compilers are not provided for every achitecture. Only the following are suported: &supported-archs;. - - - - Packages providing both native and bytecode versions of a program prog usually name them respectively prog.opt and prog.byte and provide a symbolic link prog to the best available version (generally prog.opt). - - - - The ocaml-native-compilers package contains the OCaml compiler built in native mode (ocamlc.opt, which outputs bytecode, and ocamlopt.opt, which output native code). Compiling with those versions of the compilers is generally faster. Unfortunately the ocaml-native-compilers package is not available on every architecture. Packages should therefore never depend directly on this package. In order to build big programs and benefit from this natively built compiler, packages should depend on ocaml-best-compilers which itself depends on ocaml-native-compilers where available and on ocaml elsewhere. Since it is a virtual package, it cannot (yet) be a versioned dependency. The version dependency should thus be carried by the ocaml dependency. - -
- -
- Files used by the OCaml compiler - - - The &ocaml-name; compiler can produce or use the following kind of files: - - bytecode executables (they can be recognised since they start with the shebang line #!/usr/bin/ocamlrun) - - bytecode executables linked in custom mode. They are generated by ocamlc (or ocamlc.opt), when the -custom flag is given at link time. Those executables are in ELF format and include both the final bytecode and the bytecode interpreter. strip should never be invoked on them, since it will remove the bytecode part. - - - native executables (in ELF format) - bytecode libraries (*.cma) - native libraries (*.cmxa) - shared libraries (for C bindings) (dll*.so, lib*.so) - static libraries (for C bindings) (lib*.a) - bytecode object files (*.cmo) - native object files (*.cmx) - configuration files for handling libraries with ocamlfind (META) - - - - -
- -
- Locally installing OCaml programs and libraries - - - Installation and use of locally installed OCaml related programs is out of the scope of this document. However, in order to have it work with a standard Debian installation, you should follow some guidelines. - - - - Executable files should be installed in /usr/local/bin. - - - - - Shared libraries (for C bindings) should be installed in /usr/local/lib/ocaml/&ocaml-version;/stublibs/ - - - - - Basically, every other file should be installed in /usr/local/lib/ocaml/&ocaml-version;/. This includes in particular bytecode libraries (*.cma), native libraries (*.cmxa), bytecode object files (*.cmo), native object files (*.cmx), static libraries (*.a) and META files. - - - - - - - The default configuration of ocamlfind (the OCaml - library manager recommended in Debian) first looks for a local - installation of libraries and then for libraries installed by Debian - packages. The next section describes the standard paths for files - contained in Debian packages. - - - - - The + preceding any library in the of ocamlc or ocamlopt won't be expanded to the local standard library path. You need to specify the path entirely. - - - -
diff --git a/chapter-liblocal.xml b/chapter-liblocal.xml deleted file mode 100644 index e69de29b..00000000 diff --git a/chapter-libpack.xml b/chapter-libpack.xml deleted file mode 100644 index 6469733c..00000000 --- a/chapter-libpack.xml +++ /dev/null @@ -1,272 +0,0 @@ -
- Creating a package for a library - - - A package which provides an OCaml library called xxx should be split as follows: - - - - - For libraries which are not purely programmed in OCaml (e.g. C bindings), libxxx-ocaml should provide the shared library stubs (dll*.so), and all other stuff needed to run a bytecode executable that links into this library. It should depend on ocaml-base-&ocaml-version; (or ocaml-base-nox-&ocaml-version;) as well as any other library needed. The versioned dependency on ocaml-base is important since libraries are binary incompatible between releases of OCaml. - - - libxxx-ocaml packages should be in Section: libs - - - - - libxxx-ocaml-dev should provide the rest of the library package, in fact anything needed to develop programs using the library. If the library uses other libraries or C libraries, this package should depend on them. - - - libxxx-ocaml-dev packages should be in Section: libdevel - - - - - - - Optionally, two other packages may be created: - - - - libxxx-ocaml-bin may include binaries provided by the library source package if they are numerous. This package should conform with the same regulations as other packages providing ocaml programs. It is only needed to split off this package if there is a significant number of programs included in the library, if not, the programs should go into libxxx-ocaml-dev. - - - - - libxxx-ocaml-doc may include any kind of documentation provided by the library source package or as separate documentation. Again, if there is only little documentation, they should go with the -dev package. - - - - - - - It is recommended that libraries use the option to pack all the modules provided by the library into one module. - - - We don't think upstream libraries will be moving to this scheme anytime soon (unless we actively lobby for it) so this is just a recommendation for now. - - - - It is recommended that each library package ships a META file in order to make the library usable via ocamlfind (see the Debian package ocaml-findlib). See for more information on this. - -
- -
- Paths for libraries - - - Libraries should be installed in &ocaml-sys-dir;/ or in a subdirectory of this directory. This includes in particular bytecode libraries (*.cma), native libraries (*.cmxa), bytecode object files (*.cmo), native object files (*.cmx), static libraries (*.a) and META files. The only exception to this rule is for shared libraries (dll*.so) which should be installed in &ocaml-sys-dir;/stublibs, as can it be seen in the &ocaml-sys-dir;/ld.conf file. - - - - If upstream developers already use a subdirectory of the OCaml standard library path, this path should be preserved in the Debian package but made relative to the standard library path of OCaml. Before using the provided subdirectory, packagers should obviously check if there is no subdirectory name clash with another OCaml library. - - - - If upstream developers don't use this scheme, packagers are encouraged not to install this library in the standard library directory. They should create at least a subdirectory per source package (in order to avoid name clashes). Packagers should also consider to do a larger separation by creating a subdirectory per binary package (in order to avoid META name clash). A suggested rule to choose name for this subdirectory is to use either the package name provided by the META of the upstream, or the name of the library itself. - -
- -
- Handling dependencies on OCaml - - Some parts of the package need to know the current version of OCaml. For example, libraries should be installed &ocaml-sys-dir;/. However, the current version of OCaml should never be hardcoded in the package (&ocaml-version; here). This would make a binNMU impossible when the version of OCaml changes. Instead .in files should be used where @OCamlABI@ is replaced at build-time by the current OCaml version. - - - - For example, the package ocaml-mad would normally contain a file libmad-ocaml-dev.install for installing files with dh_install, containing: - - usr/lib/ocaml/&ocaml-version;/mad/META - usr/lib/ocaml/&ocaml-version;/mad/*.a - usr/lib/ocaml/&ocaml-version;/mad/*.cm* - usr/lib/ocaml/&ocaml-version;/mad/*.ml* - - In order to avoid the explicit mention of the version of OCaml (&ocaml-version;), the package actually contains instead a file libmad-ocaml-dev.install.in which contains: - - usr/lib/ocaml/@OCamlABI@/mad/META - usr/lib/ocaml/@OCamlABI@/mad/*.a - usr/lib/ocaml/@OCamlABI@/mad/*.cm* - usr/lib/ocaml/@OCamlABI@/mad/*.ml* - - The string @OCamlABI@ is substituted at build-time by the version of OCaml. Here are the relevant parts of the debian/rules file: - - OCAMLABI := $(shell ocamlc -version) - OFILES := $(filter-out debian/control,(patsubst %.in,%,$(wildcard debian/*.in))) - - ocamlinit: - for f in $(OFILES); do sed -e 's/@OCamlABI@/$(OCAMLABI)/g' $$f.in > $$f; done - - config.status: ocamlinit configure - [...] - - .PHONY: build clean binary-indep binary-arch binary install ocamlinit - - - - - The only exception to this rule (properly handled by the example above) is the debian/control file, which should never be generated at build-time. As explained in , the dependency should nevertheless not hardcode the version of OCaml: the debian/control file should have a Depends: ocaml-base-nox-${F:OCamlABI} which is filled by a dh_gencontrol -s -- -VF:OCamlABI="$(OCAMLABI)" in the debian/rules file. - -
- -
- Providing <filename>META</filename> files - - - The ocaml-findlib provides a tool (named ocamlfind) to handle OCaml libraries and store information about libraries dependencies, compiler flags, linking options, etc. Meta informations regarding a library are contained in files (usually one for each library), named META files, contained in the library directory. The distribution of META files is the best way to make more easy to use the Debian-specific oragnization of libraries. Packages distributing META files should suggest the use of &ocamlfind;, that is have a Suggest: ocaml-findlib. - - - - By default, &ocamlfind; will look for META in this order: - - &ocaml-metas-dir;/ - &ocaml-sys-dir;/package/ - - - - - The naming scheme of META is pretty simple. - - - - If the META file is placed in the subdirectory - of the package, it should be called META. - - - - - If the META file is placed in &ocaml-metas-dir;/, it should be called META.packagename, where packagename is the name of the subdirectory where the library is stored. - - - - - - - For example, the META file for the lablgtk library is named META and has path &ocaml-sys-dir;/lablgtk/META, where &ocaml-sys-dir; is the main OCaml installation directory and lablgtk is the lablgtk library directory. - - - - If upstream doesn't provide a META, packagers are encouraged to create one. In this case, the META should be sent to upstream authors, in order to have it included in the next version of the upstream source. For more information about META files, have a look at the Findlib manual, at the several META files provided by other packages (e.g. lablgtk, pxp, pcre, netstring, lablgl, ...) or ask on the debian-ocaml-maint mailing list for help. - -
- - - -
- &camlp4; - - Actually, &camlp4; extensions are stored in - &ocaml-sys-dir;/camlp4/. In order to do something - cleaner, &ocaml-force; proposes to put this files in their own directory, even in their - own package. It is not mandatory, but it could ease a lot by avoiding - name clashes. - - - - You just have to consider a &camlp4; file just as a standard library, except that you - prefix them with -syntax. For example: the syntax - extension coming with libokey-ocaml-dev should be stored - in &ocaml-sys-dir;/okey-syntax/, the package - containing it should be called libokey-syntax-ocaml-dev. - - - - It is recommended to use META to specify how to handle this - extension. - - - - All definition is taken from previous text considering syntax extension as a standalone - library. - - -
- -
- Documentation - - The documentation is a joint effort of &ocaml-force; and usptream. - There are many ways to have documentation: - - header files (*.mli), - source files (*.ml), - specific documentation provided by the upstream, - OCamldoc generated documentation. - - - - - This documentation should be browsable by different mean, from the - most simple to the most complex. At least, they should all be readable with - simple text editor. Specific and &ocamldoc; generated documentations should be provided in HTML format. - There are also at least two - specific &ocaml-name; browser : docbrowse shipped - with cameleon and ocamlbrowser - shipped with &ocaml-name; itself. The first one, needs specific - &ocamldoc; generated documentation. The second one enables - the user to browse directly the prototype of each function shipped in the cmi gives - to the application. - - - - You can generate &ocamldoc;-specific documentation by using - the of this application. By using this, you dump the - intermediary representation of the document that will be generated by ocamldoc. - This can be used to generate HTML documentation and manpages, by reloading this - file (using ). - - - - As of today, there is no way to post-process &ocamldoc; - specific documentation. A &debian-name; package is under construction to do this - task. It will be referred as &ocamldoc-base;. - -
diff --git a/chapter-progpack.xml b/chapter-progpack.xml deleted file mode 100644 index 353bbe30..00000000 --- a/chapter-progpack.xml +++ /dev/null @@ -1,85 +0,0 @@ -
- Creating a package for an OCaml program - - Any package providing executables built from OCaml source should conform to the following guidelines. - - - - The source package should, if possible, use the name of the upstream - package without modifications. - - - - Programs which are not particularly CPU angry should be compiled in - bytecode form and the corresponding binary packages should be - Architecture: all in order to minimize archive usage and - avoid the need of rebuilding them on all architectures. Other programs - should be compiled in native form on architectures where the native - compiler is available, and in bytecode on other architectures. - See for details on how to achieve - this. The corresponding binary packages should be Architecture: - any and will need to be built on any architecture. - - - - All bytecode executables should be linked dynamically against the shared libraries for C bindings, so as to not bloat the archive. - - - That said, often the upstream authors will favor statically linked bytecode executables, because so they don't need to worry about the presence of the dll stub libraries and such. This is not a valid reason to use statically linked bytecode in a Debian package. - - - -
- -
- Bytecode and native versions of programs - - As explained in , native OCaml compilers are not available everywhere. For architectures missing native compiler, a bytecode version of the program should be provided. - - - - The package's debian/rules should build the native code executable if supported on the architecture it is built on, and fall back to building the bytecode version if no working native code compiler is available. Exceptions to this are the executables who are small or not time critical, which may be built only as bytecode. It is the decision of the individual maintainers to choose this, maybe guided by the practice of the upstream author. - - - - The availability of the native compiler can be tested in the debian/rules file by testing the possibility of executing /usr/bin/ocamlopt, and build the bytecode version or the native version of the program according to the result of the test. This is a sample snippet of debian/rules doing so: - - build-stamp: - dh_testdir - - if [ -x /usr/bin/ocamlopt ]; then \ - $(MAKE) opt; \ - else; \ - $(MAKE) all; \ - fi - - - - - The bytecode versions are portable. In order to spare the buildds and the Debian archive, bytecode versions should be compiled once for all for big packages (which either take a lot of place on disks or take a lot of time to build). For example, the spamoracle package provides the spamoracle-byte package which is Architecture: all and contains the bytecode version of spamoracle, and the spamoracle package which contains the native version of spamoracle and is available only where a native OCaml compiler is available (Architecture: alpha amd64 arm i386 ia64 kfreebsd-i386 powerpc sparc). - - - - Bytecode versions of the programs should depend on ocaml-base-nox-&ocaml-version; (or ocaml-base-&ocaml-version; the program either uses the Graphics or the LablTk module). In order for the package to be able to be rebuilt or even binNMUed without a change in the packaging, this version should not be hardcoded in the debian/control file. Instead, the package should depend on ocaml-base-nox-${F:OCamlABI} and use OCAMLABI := $(shell ocamlc -version) and dh_gencontrol -- -VF:OCamlABI="$(OCAMLABI)" in the debian/rules file. - - - The following is a snippet of a sample debian/control: - - Package: spamoracle-byte - Architecture: all - Depends: ocaml-base-nox-${F:OCamlABI} - Provides: spamoracle - Conflicts: spamoracle - Replaces: spamoracle - - - The following its pairing debian/rules snippet: - - OCAMLABI := $(shell ocamlc -version) - ... - binary-indep: build install - dh_gencontrol -i -- -VF:OCamlABI="$(OCAMLABI)" - - - -
diff --git a/debian/policy/Makefile b/debian/policy/Makefile new file mode 100644 index 00000000..05f3a7fb --- /dev/null +++ b/debian/policy/Makefile @@ -0,0 +1,12 @@ +all: html text + +html: + docbook2html ocaml_packaging_policy.xml -o packaging-policy-html + +text: + docbook2txt ocaml_packaging_policy.xml + +clean: + $(RM) -rf packaging-policy-html ocaml_packaging_policy.txt + +.PHONY: html text diff --git a/debian/policy/README b/debian/policy/README new file mode 100644 index 00000000..64b5e6de --- /dev/null +++ b/debian/policy/README @@ -0,0 +1,20 @@ +----------------------- +* * +* HOWTO-XML * +* DOCBOOK * +* * +* * +----------------------- + + +If you are interested in writing in the policy, you should +take a look at + +http://docbook.sourceforge.net/ +http://www.oasis-open.org/docbook/documentation/reference/html/docbook.html + +When you finish write your part, just do a make clean && make all. It will result +in having ocaml_packaging_policy.html... + +Sylvain LE GALL +Sat, 18 October 2003 diff --git a/debian/policy/appendix-resources.xml b/debian/policy/appendix-resources.xml new file mode 100644 index 00000000..aea329b3 --- /dev/null +++ b/debian/policy/appendix-resources.xml @@ -0,0 +1,6 @@ + + + &ocaml-force;'s website: http://pkg-ocaml-maint.alioth.debian.org/ (it's an Alioth project) + &ocaml-force;'s mailing list: debian-ocaml-maint@lists.debian.org (archives) + + diff --git a/debian/policy/appendix-svn.xml b/debian/policy/appendix-svn.xml new file mode 100644 index 00000000..a40a681f --- /dev/null +++ b/debian/policy/appendix-svn.xml @@ -0,0 +1,229 @@ +
+ How to obtain a copy of the SVN archive + + You can obtain a copy of debian-ocaml-maint SVN archive by + +svn co svn+ssh://svn.debian.org/svn/pkg-ocaml-maint + + You must be member of the + Debian + OCaml Task Force in order to have write access to this archive. + +
+ +
+ Structure of the SVN archive + + We keep all files of the debian subdirectory under svn control, and + upstream only as a compressed tarball. The rationale behind this is + that changes to upstream files should be managed by the dpatch patch + manager. Hence, all the diffs to upstream files are kept in a + subdirectory of debian/, and it is not necessary to manage upstream on + file-by-file basis. + + + + The structure of the pkg-ocaml-maint svn archive is as follows, where + generic names are indicated in square brackets [ .. ], and where the + contents of subdirectories not directly relevant for package management + are not detailed: + + tags + packages + [package1] + [version1] + [version2] + ... + [package2] + [version1] + ... + ... + projects + test + trunk + packages + [package1] + trunk + debian + upstream + [upstream-tarball-version1] + [upstream-tarball-version2] + ... + [package2] + ... + policy + projects + tools + + +
+ +
+ How to add a new package to the SVN archive + + Place yourself in the directory trunk/packages of your working copy of + the svn repository. Create a directory with the same name as your + source package (let's say, my-package), and subdirectories upstream + and trunk. Put the current upstream tarball in upstream, and the + current debian directory with all its relevant files in trunk. This + should now look like this: + + trunk/packages/my_package + upstream + my_package_1.2.3.orig.tar.gz + trunk + debian + changelog + control + copyright + patches + 00_list + 01_patch1.dpatch + ... + ... + + + + + If everything is in order you can do a svn add my_package from the trunk/packages directory, and eventually svn commit. + +
+ +
+ How to set up your package for use with <application>svn-buildpackage</application> + + + Please see the svn-buildpackage documentation for complete + information. The important issues here are: + + + + Since we keep upstream as a tarball we have to use svn-buildpackage in + so-called merge mode. This means that, before compiling the package, + the debianized source tree is constructed by untarring the orig tarball, and then merging the contents of the trunk subdirectory in it. + + + + + The structure of our svn repository is not among the default structures + of svn-buildpackage. Hence, we have to override the default location of some + directories. + + + + + + + Place yourself in trunk/packages/my_packages/trunk, and do the following: + svn propset mergeWithUpstream 1 debian. + This registers the property "mergeWithUpstream" with the current + directory, such that svn-buildpackage knows that it has to use merge + mode as explained above. + + + + Create a file debian/svn-deblayout with the following contents: + +origDir=../upstream +origUrl=svn+ssh://svn.debian.org/svn/pkg-ocaml-maint/trunk/packages/my_package/upstream +tagsUrl=svn+ssh://svn.debian.org/svn/pkg-ocaml-maint/tags/packages/my_package + + + + + Remember that "my_package" has to be replaced by the name of your + actual package. svn-buildpackage will not include this file in the + source package when actually building the package. + + + + If you tried svn-buildpackage before writing your debian/svn-deblayout remember + to delete .svn/deb-layout, since svn-buildpackages caches here the content + of svn-deblayout (that would be empty in this case) and will ignore + your debian/svn-deblayout. + +
+ +
+ How to build a package with <application>svn-buildpackage</application> + + + Please refer to the svn-builpackage documentation for more complete + information. Here is just a quick guide. + + + + All options, except those starting on , are passed to + dpkg-buildpackage. Hence, basic usage should be something like this + (from the trunk/packages/my_package/trunk directory): svn-buildpackage -rfakeroot -uc -us. + + + + svn-buildpackage will complain when your copy of the debian directory + is not in sync with the repository. You may use the option + to override this behaviour. The package will be + build in the directory ../build-area. + + + + If your package is ready for upload you may use the option + for the final build. This will put a tag in the svn-repository on the + current version, and add a new entry in the changlog to start working + on the upcomming next version: svn-buildpackage --svn-tag. + Provided you have commited all your changes to the svn repository, this + will after a successful build of the package create a tag for the current + version in tags/packages/my_package. The tagging is done directly in the + svn repository. + + + + + Some useful aliases took from the svn-buildpackage HOWTO: + +alias svn-b='svn-buildpackage -rfakeroot --svn-dont-clean -us -uc --svn-ignore' +alias svn-bt='svn-buildpackage -rfakeroot --svn-lintian --svn-dont-clean --svn-tag' + + + + + The former (svn-b) is to be used for test builds, while you are + working on your package; while the latter (svn-bt) is to be used at + the end, after you commit your changes and just before uploading a new + version of the package to the debian archive. + + + + Adding -k<your gpg id> to the svn-bt alias may also be useful when working on + collaboratively maintained packages: + +alias svn-bt='svn-buildpackage -rfakeroot -k<gpgid> --svn-lintian --svn-dont-clean --svn-tag' + + + +
+ +
+ dpatch + + + dpatch will work properly at package build time with the svn + structure described above since all of the build process will be + carried out in a fresh directory. However, invoking + debian/rules with the "clean" target in + the trunk/ directory will fail since + dpatch is unable to de-apply patches. Passing + to + svn-buildpackage fixes this + misbehaviour (aliases suggested above already include this + flag). + + + If you want to use dpatch-edit-patch to handle patches, you will need to invoke + it in "debian only mode" ( flag, see man dpatch-edit-patch) and to tell him + where to find the upstream tarball. Adding the following line to your + ~/.dpatch.conf will be enough: + +conf_origtargzpath=../upstream + + +
diff --git a/debian/policy/authors.xml b/debian/policy/authors.xml new file mode 100644 index 00000000..26819dd7 --- /dev/null +++ b/debian/policy/authors.xml @@ -0,0 +1,30 @@ + + + + The Debian OCaml Task Force +
debian-ocaml-maint@lists.debian.org
+ + diff --git a/debian/policy/chapter-generalities.xml b/debian/policy/chapter-generalities.xml new file mode 100644 index 00000000..db03cc6e --- /dev/null +++ b/debian/policy/chapter-generalities.xml @@ -0,0 +1,149 @@ +
+ OCaml in Debian + + At the time of this writing, the latest version of OCaml in Debian is &ocaml-version;. + + + + The ocaml package depends on all the basic packages needed to develop programs with OCaml. More specifically, the packaging of OCaml is split into smaller packages. The packages with suffix -nox contain libraries which don't need X (i.e., for the programs which don't use the Graphics or LablTk modules) in order to avoid dependencies on big packages for users who do not need to run graphical applications. Here is the list of binary packages in which OCaml is split: + + + + The ocaml and ocaml-nox packages contain the compiler and its libraries. + + + + + The ocaml-native-compilers package contains the OCaml compilers built in native mode (ocamlc.opt and ocamlopt.opt). + + + The compilers themselves are built in native mode, nonetheless, both compilers for compiling toward bytecode and native code are contained in this package. + + + + + The ocaml-base and ocaml-base-nox packages contain the interpreter and runtime libraries needed by bytecode programs compiled with OCaml (in particular, the package ocaml-base-nox contains the ocamlrun program). + + + + + The ocaml-interp package contains the toplevel system for OCaml (ocaml), that enables interactive use of the language. + + + + + The ocaml-mode package contains the OCaml Emacs mode (the one provided with OCaml, not the tuareg mode which is in the package tuareg-mode). + + + + + The ocaml-source package contains the sources of the OCaml compiler. + + + + + The ocaml-compiler-libs package contains some internal libraries of the OCaml compiler (needed only in very rare cases, e.g. for developing languages which reuse OCaml internals). + + + + + + + Since libraries produced by OCaml are binary incompatible when compiled with different releases of OCaml, versioned virtual packages are also provided by packages at items (1) and (2): ocaml-&ocaml-version;, ocaml-nox-&ocaml-version;, ocaml-base-&ocaml-version;, ocaml-base-nox-&ocaml-version;. + + +
+ OCaml location + + The root of all installed OCaml libraries is the OCaml + standard library directory, which is + /usr/lib/ocaml/VERSION/, at the time of writing + &ocaml-sys-dir;. It can be output + by the OCaml compiler invoking it as ocamlc -where. + + +
+ +
+ +
+ Bytecode and native programs + + + The OCaml compiler can produce two kinds of executables: bytecode and native. The native executables (compiled with ocamlopt) are generally faster since they are compiled specifically for an achitecture. The bytecode executables (compiled with ocamlc) have the advantage of being portable, which means that a bytecode program can be run on any achitecture without needing to be rebuilt. It should be noted that native OCaml compilers are not provided for every achitecture. Only the following are suported: &supported-archs;. + + + + Packages providing both native and bytecode versions of a program prog usually name them respectively prog.opt and prog.byte and provide a symbolic link prog to the best available version (generally prog.opt). + + + + The ocaml-native-compilers package contains the OCaml compiler built in native mode (ocamlc.opt, which outputs bytecode, and ocamlopt.opt, which output native code). Compiling with those versions of the compilers is generally faster. Unfortunately the ocaml-native-compilers package is not available on every architecture. Packages should therefore never depend directly on this package. In order to build big programs and benefit from this natively built compiler, packages should depend on ocaml-best-compilers which itself depends on ocaml-native-compilers where available and on ocaml elsewhere. Since it is a virtual package, it cannot (yet) be a versioned dependency. The version dependency should thus be carried by the ocaml dependency. + +
+ +
+ Files used by the OCaml compiler + + + The &ocaml-name; compiler can produce or use the following kind of files: + + bytecode executables (they can be recognised since they start with the shebang line #!/usr/bin/ocamlrun) + + bytecode executables linked in custom mode. They are generated by ocamlc (or ocamlc.opt), when the -custom flag is given at link time. Those executables are in ELF format and include both the final bytecode and the bytecode interpreter. strip should never be invoked on them, since it will remove the bytecode part. + + + native executables (in ELF format) + bytecode libraries (*.cma) + native libraries (*.cmxa) + shared libraries (for C bindings) (dll*.so, lib*.so) + static libraries (for C bindings) (lib*.a) + bytecode object files (*.cmo) + native object files (*.cmx) + configuration files for handling libraries with ocamlfind (META) + + + + +
+ +
+ Locally installing OCaml programs and libraries + + + Installation and use of locally installed OCaml related programs is out of the scope of this document. However, in order to have it work with a standard Debian installation, you should follow some guidelines. + + + + Executable files should be installed in /usr/local/bin. + + + + + Shared libraries (for C bindings) should be installed in /usr/local/lib/ocaml/&ocaml-version;/stublibs/ + + + + + Basically, every other file should be installed in /usr/local/lib/ocaml/&ocaml-version;/. This includes in particular bytecode libraries (*.cma), native libraries (*.cmxa), bytecode object files (*.cmo), native object files (*.cmx), static libraries (*.a) and META files. + + + + + + + The default configuration of ocamlfind (the OCaml + library manager recommended in Debian) first looks for a local + installation of libraries and then for libraries installed by Debian + packages. The next section describes the standard paths for files + contained in Debian packages. + + + + + The + preceding any library in the of ocamlc or ocamlopt won't be expanded to the local standard library path. You need to specify the path entirely. + + + +
diff --git a/debian/policy/chapter-liblocal.xml b/debian/policy/chapter-liblocal.xml new file mode 100644 index 00000000..e69de29b diff --git a/debian/policy/chapter-libpack.xml b/debian/policy/chapter-libpack.xml new file mode 100644 index 00000000..6469733c --- /dev/null +++ b/debian/policy/chapter-libpack.xml @@ -0,0 +1,272 @@ +
+ Creating a package for a library + + + A package which provides an OCaml library called xxx should be split as follows: + + + + + For libraries which are not purely programmed in OCaml (e.g. C bindings), libxxx-ocaml should provide the shared library stubs (dll*.so), and all other stuff needed to run a bytecode executable that links into this library. It should depend on ocaml-base-&ocaml-version; (or ocaml-base-nox-&ocaml-version;) as well as any other library needed. The versioned dependency on ocaml-base is important since libraries are binary incompatible between releases of OCaml. + + + libxxx-ocaml packages should be in Section: libs + + + + + libxxx-ocaml-dev should provide the rest of the library package, in fact anything needed to develop programs using the library. If the library uses other libraries or C libraries, this package should depend on them. + + + libxxx-ocaml-dev packages should be in Section: libdevel + + + + + + + Optionally, two other packages may be created: + + + + libxxx-ocaml-bin may include binaries provided by the library source package if they are numerous. This package should conform with the same regulations as other packages providing ocaml programs. It is only needed to split off this package if there is a significant number of programs included in the library, if not, the programs should go into libxxx-ocaml-dev. + + + + + libxxx-ocaml-doc may include any kind of documentation provided by the library source package or as separate documentation. Again, if there is only little documentation, they should go with the -dev package. + + + + + + + It is recommended that libraries use the option to pack all the modules provided by the library into one module. + + + We don't think upstream libraries will be moving to this scheme anytime soon (unless we actively lobby for it) so this is just a recommendation for now. + + + + It is recommended that each library package ships a META file in order to make the library usable via ocamlfind (see the Debian package ocaml-findlib). See for more information on this. + +
+ +
+ Paths for libraries + + + Libraries should be installed in &ocaml-sys-dir;/ or in a subdirectory of this directory. This includes in particular bytecode libraries (*.cma), native libraries (*.cmxa), bytecode object files (*.cmo), native object files (*.cmx), static libraries (*.a) and META files. The only exception to this rule is for shared libraries (dll*.so) which should be installed in &ocaml-sys-dir;/stublibs, as can it be seen in the &ocaml-sys-dir;/ld.conf file. + + + + If upstream developers already use a subdirectory of the OCaml standard library path, this path should be preserved in the Debian package but made relative to the standard library path of OCaml. Before using the provided subdirectory, packagers should obviously check if there is no subdirectory name clash with another OCaml library. + + + + If upstream developers don't use this scheme, packagers are encouraged not to install this library in the standard library directory. They should create at least a subdirectory per source package (in order to avoid name clashes). Packagers should also consider to do a larger separation by creating a subdirectory per binary package (in order to avoid META name clash). A suggested rule to choose name for this subdirectory is to use either the package name provided by the META of the upstream, or the name of the library itself. + +
+ +
+ Handling dependencies on OCaml + + Some parts of the package need to know the current version of OCaml. For example, libraries should be installed &ocaml-sys-dir;/. However, the current version of OCaml should never be hardcoded in the package (&ocaml-version; here). This would make a binNMU impossible when the version of OCaml changes. Instead .in files should be used where @OCamlABI@ is replaced at build-time by the current OCaml version. + + + + For example, the package ocaml-mad would normally contain a file libmad-ocaml-dev.install for installing files with dh_install, containing: + + usr/lib/ocaml/&ocaml-version;/mad/META + usr/lib/ocaml/&ocaml-version;/mad/*.a + usr/lib/ocaml/&ocaml-version;/mad/*.cm* + usr/lib/ocaml/&ocaml-version;/mad/*.ml* + + In order to avoid the explicit mention of the version of OCaml (&ocaml-version;), the package actually contains instead a file libmad-ocaml-dev.install.in which contains: + + usr/lib/ocaml/@OCamlABI@/mad/META + usr/lib/ocaml/@OCamlABI@/mad/*.a + usr/lib/ocaml/@OCamlABI@/mad/*.cm* + usr/lib/ocaml/@OCamlABI@/mad/*.ml* + + The string @OCamlABI@ is substituted at build-time by the version of OCaml. Here are the relevant parts of the debian/rules file: + + OCAMLABI := $(shell ocamlc -version) + OFILES := $(filter-out debian/control,(patsubst %.in,%,$(wildcard debian/*.in))) + + ocamlinit: + for f in $(OFILES); do sed -e 's/@OCamlABI@/$(OCAMLABI)/g' $$f.in > $$f; done + + config.status: ocamlinit configure + [...] + + .PHONY: build clean binary-indep binary-arch binary install ocamlinit + + + + + The only exception to this rule (properly handled by the example above) is the debian/control file, which should never be generated at build-time. As explained in , the dependency should nevertheless not hardcode the version of OCaml: the debian/control file should have a Depends: ocaml-base-nox-${F:OCamlABI} which is filled by a dh_gencontrol -s -- -VF:OCamlABI="$(OCAMLABI)" in the debian/rules file. + +
+ +
+ Providing <filename>META</filename> files + + + The ocaml-findlib provides a tool (named ocamlfind) to handle OCaml libraries and store information about libraries dependencies, compiler flags, linking options, etc. Meta informations regarding a library are contained in files (usually one for each library), named META files, contained in the library directory. The distribution of META files is the best way to make more easy to use the Debian-specific oragnization of libraries. Packages distributing META files should suggest the use of &ocamlfind;, that is have a Suggest: ocaml-findlib. + + + + By default, &ocamlfind; will look for META in this order: + + &ocaml-metas-dir;/ + &ocaml-sys-dir;/package/ + + + + + The naming scheme of META is pretty simple. + + + + If the META file is placed in the subdirectory + of the package, it should be called META. + + + + + If the META file is placed in &ocaml-metas-dir;/, it should be called META.packagename, where packagename is the name of the subdirectory where the library is stored. + + + + + + + For example, the META file for the lablgtk library is named META and has path &ocaml-sys-dir;/lablgtk/META, where &ocaml-sys-dir; is the main OCaml installation directory and lablgtk is the lablgtk library directory. + + + + If upstream doesn't provide a META, packagers are encouraged to create one. In this case, the META should be sent to upstream authors, in order to have it included in the next version of the upstream source. For more information about META files, have a look at the Findlib manual, at the several META files provided by other packages (e.g. lablgtk, pxp, pcre, netstring, lablgl, ...) or ask on the debian-ocaml-maint mailing list for help. + +
+ + + +
+ &camlp4; + + Actually, &camlp4; extensions are stored in + &ocaml-sys-dir;/camlp4/. In order to do something + cleaner, &ocaml-force; proposes to put this files in their own directory, even in their + own package. It is not mandatory, but it could ease a lot by avoiding + name clashes. + + + + You just have to consider a &camlp4; file just as a standard library, except that you + prefix them with -syntax. For example: the syntax + extension coming with libokey-ocaml-dev should be stored + in &ocaml-sys-dir;/okey-syntax/, the package + containing it should be called libokey-syntax-ocaml-dev. + + + + It is recommended to use META to specify how to handle this + extension. + + + + All definition is taken from previous text considering syntax extension as a standalone + library. + + +
+ +
+ Documentation + + The documentation is a joint effort of &ocaml-force; and usptream. + There are many ways to have documentation: + + header files (*.mli), + source files (*.ml), + specific documentation provided by the upstream, + OCamldoc generated documentation. + + + + + This documentation should be browsable by different mean, from the + most simple to the most complex. At least, they should all be readable with + simple text editor. Specific and &ocamldoc; generated documentations should be provided in HTML format. + There are also at least two + specific &ocaml-name; browser : docbrowse shipped + with cameleon and ocamlbrowser + shipped with &ocaml-name; itself. The first one, needs specific + &ocamldoc; generated documentation. The second one enables + the user to browse directly the prototype of each function shipped in the cmi gives + to the application. + + + + You can generate &ocamldoc;-specific documentation by using + the of this application. By using this, you dump the + intermediary representation of the document that will be generated by ocamldoc. + This can be used to generate HTML documentation and manpages, by reloading this + file (using ). + + + + As of today, there is no way to post-process &ocamldoc; + specific documentation. A &debian-name; package is under construction to do this + task. It will be referred as &ocamldoc-base;. + +
diff --git a/debian/policy/chapter-progpack.xml b/debian/policy/chapter-progpack.xml new file mode 100644 index 00000000..353bbe30 --- /dev/null +++ b/debian/policy/chapter-progpack.xml @@ -0,0 +1,85 @@ +
+ Creating a package for an OCaml program + + Any package providing executables built from OCaml source should conform to the following guidelines. + + + + The source package should, if possible, use the name of the upstream + package without modifications. + + + + Programs which are not particularly CPU angry should be compiled in + bytecode form and the corresponding binary packages should be + Architecture: all in order to minimize archive usage and + avoid the need of rebuilding them on all architectures. Other programs + should be compiled in native form on architectures where the native + compiler is available, and in bytecode on other architectures. + See for details on how to achieve + this. The corresponding binary packages should be Architecture: + any and will need to be built on any architecture. + + + + All bytecode executables should be linked dynamically against the shared libraries for C bindings, so as to not bloat the archive. + + + That said, often the upstream authors will favor statically linked bytecode executables, because so they don't need to worry about the presence of the dll stub libraries and such. This is not a valid reason to use statically linked bytecode in a Debian package. + + + +
+ +
+ Bytecode and native versions of programs + + As explained in , native OCaml compilers are not available everywhere. For architectures missing native compiler, a bytecode version of the program should be provided. + + + + The package's debian/rules should build the native code executable if supported on the architecture it is built on, and fall back to building the bytecode version if no working native code compiler is available. Exceptions to this are the executables who are small or not time critical, which may be built only as bytecode. It is the decision of the individual maintainers to choose this, maybe guided by the practice of the upstream author. + + + + The availability of the native compiler can be tested in the debian/rules file by testing the possibility of executing /usr/bin/ocamlopt, and build the bytecode version or the native version of the program according to the result of the test. This is a sample snippet of debian/rules doing so: + + build-stamp: + dh_testdir + + if [ -x /usr/bin/ocamlopt ]; then \ + $(MAKE) opt; \ + else; \ + $(MAKE) all; \ + fi + + + + + The bytecode versions are portable. In order to spare the buildds and the Debian archive, bytecode versions should be compiled once for all for big packages (which either take a lot of place on disks or take a lot of time to build). For example, the spamoracle package provides the spamoracle-byte package which is Architecture: all and contains the bytecode version of spamoracle, and the spamoracle package which contains the native version of spamoracle and is available only where a native OCaml compiler is available (Architecture: alpha amd64 arm i386 ia64 kfreebsd-i386 powerpc sparc). + + + + Bytecode versions of the programs should depend on ocaml-base-nox-&ocaml-version; (or ocaml-base-&ocaml-version; the program either uses the Graphics or the LablTk module). In order for the package to be able to be rebuilt or even binNMUed without a change in the packaging, this version should not be hardcoded in the debian/control file. Instead, the package should depend on ocaml-base-nox-${F:OCamlABI} and use OCAMLABI := $(shell ocamlc -version) and dh_gencontrol -- -VF:OCamlABI="$(OCAMLABI)" in the debian/rules file. + + + The following is a snippet of a sample debian/control: + + Package: spamoracle-byte + Architecture: all + Depends: ocaml-base-nox-${F:OCamlABI} + Provides: spamoracle + Conflicts: spamoracle + Replaces: spamoracle + + + The following its pairing debian/rules snippet: + + OCAMLABI := $(shell ocamlc -version) + ... + binary-indep: build install + dh_gencontrol -i -- -VF:OCamlABI="$(OCAMLABI)" + + + +
diff --git a/debian/policy/legal.xml b/debian/policy/legal.xml new file mode 100644 index 00000000..a1d3f782 --- /dev/null +++ b/debian/policy/legal.xml @@ -0,0 +1,29 @@ + + 20022003200420052006 + Sylvain LE GALL, Sven LUTHER, Samuel MIMRAM and Stefano ZACCHIROLI + + + + This manual is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version + 2 of the License, or (at your option) any later version. + + + This is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See + the GNU General Public License for more details. + + + A copy of the GNU General Public License is available as + /usr/share/common-licenses/GPL in the Debian GNU/Linux + distribution or on the World Wide Web at + The GNU Public Licence. + + + You can also obtain it by writing to the + Free Software Foundation, Inc., 59 Temple Place - Suite 330, + Boston, MA 02111-1307, USA. + + diff --git a/debian/policy/ocaml_packaging_policy.xml b/debian/policy/ocaml_packaging_policy.xml new file mode 100644 index 00000000..41363ede --- /dev/null +++ b/debian/policy/ocaml_packaging_policy.xml @@ -0,0 +1,65 @@ + + + + + + + +ocaml"> +ocaml-&ocaml-version;"> +ocaml-base-&ocaml-version;"> +ocaml-findlib"> +ocamldoc-base"> +OCaml"> + +ocamlc"> +ocamlopt"> +ocamldoc"> +ocamlfind"> +CamlP4"> + + + + + + + + + + +]> + + + &debian-name; &ocaml-name; Packaging Policy for OCaml &ocaml-version; + Revision 0.7 + &authors; + &legal; + + + + Generalities about &ocaml-name; packages in Debian + &chapter-generalities; + + + + Packaging OCaml Programs + &chapter-progpack; + + + + Packaging OCaml libraries + &chapter-libpack; + + + + &ocaml-force; resources + &appendix-resources; + + + + Using the SVN repository + &appendix-svn; + + diff --git a/legal.xml b/legal.xml deleted file mode 100644 index a1d3f782..00000000 --- a/legal.xml +++ /dev/null @@ -1,29 +0,0 @@ - - 20022003200420052006 - Sylvain LE GALL, Sven LUTHER, Samuel MIMRAM and Stefano ZACCHIROLI - - - - This manual is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version - 2 of the License, or (at your option) any later version. - - - This is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See - the GNU General Public License for more details. - - - A copy of the GNU General Public License is available as - /usr/share/common-licenses/GPL in the Debian GNU/Linux - distribution or on the World Wide Web at - The GNU Public Licence. - - - You can also obtain it by writing to the - Free Software Foundation, Inc., 59 Temple Place - Suite 330, - Boston, MA 02111-1307, USA. - - diff --git a/ocaml_packaging_policy.xml b/ocaml_packaging_policy.xml deleted file mode 100644 index 41363ede..00000000 --- a/ocaml_packaging_policy.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - -ocaml"> -ocaml-&ocaml-version;"> -ocaml-base-&ocaml-version;"> -ocaml-findlib"> -ocamldoc-base"> -OCaml"> - -ocamlc"> -ocamlopt"> -ocamldoc"> -ocamlfind"> -CamlP4"> - - - - - - - - - - -]> - - - &debian-name; &ocaml-name; Packaging Policy for OCaml &ocaml-version; - Revision 0.7 - &authors; - &legal; - - - - Generalities about &ocaml-name; packages in Debian - &chapter-generalities; - - - - Packaging OCaml Programs - &chapter-progpack; - - - - Packaging OCaml libraries - &chapter-libpack; - - - - &ocaml-force; resources - &appendix-resources; - - - - Using the SVN repository - &appendix-svn; - -