Linux Certif

Toute la documentation sur la certification Linux LPI

dh_ocamldoc

NAME

dh_ocamldoc - Generates documentation for OCaml libraries

SYNOPSIS

dh_ocamldoc [debhelper options]

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 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. 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.

OPTIONS

-X files

Exclude files from documentation processing.

-u flags

Additional flags to ``ocamldoc'' or ``ocamlfind ocamldoc''.

SEE ALSO

debhelper(7), dh(1), dh_ocaml(1)

This program is meant to be used together with debhelper.

AUTHOR

Mehdi Dogguy <mehdi@debian.org>