From: Stephane Glondu Date: Thu, 11 Jul 2019 11:40:58 +0000 (+0200) Subject: Fix broken doc symlinks (Closes: #877267) X-Git-Tag: archive/raspbian/4.08.1-4+rpi1~2^2~17^2~44 X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=e3feda556f747c85c81027081b65a797d5a93ce4;p=ocaml.git Fix broken doc symlinks (Closes: #877267) --- diff --git a/debian/MANIFEST b/debian/MANIFEST index 35f86190..7198450a 100644 --- a/debian/MANIFEST +++ b/debian/MANIFEST @@ -1,5 +1,5 @@ debian/MANIFEST -debian/README.Debian +debian/OCaml_for_Debian debian/README.source debian/TODO.Debian debian/changelog @@ -15,7 +15,6 @@ debian/man/ocamldumpobj.1 debian/man/ocamlmklib.1 debian/man/ocamlobjinfo.1 debian/native-archs -debian/ocaml-base-nox.README.Debian debian/ocaml-base-nox.dirs.in debian/ocaml-base-nox.docs debian/ocaml-base-nox.install.in diff --git a/debian/OCaml_for_Debian b/debian/OCaml_for_Debian new file mode 100644 index 00000000..67213a3f --- /dev/null +++ b/debian/OCaml_for_Debian @@ -0,0 +1,70 @@ +OCaml for Debian +---------------- + + 1) The OCaml package has been split into different binary packages: + + o ocaml: contains the full OCaml suite + o ocaml-nox: the full suite except for the Graphics and Tk modules + o ocaml-base: contains the runtime stuff (ocamlrun + dlls + Tk) + o ocaml-base-nox: contains the runtime stuff (ocamlrun + dlls - Tk) + + o ocaml-compiler-libs: contains several modules used internally by + the OCaml compilers. They are not needed for normal OCaml + development, but may be helpful in the development of certain + applications. + o ocaml-source: contains the full OCaml source for the (few) packages which + need them at build time or for personal use (it should _not_ be used to + build OCaml itself). + + o ocaml-mode: contains a major mode for editing OCaml files in Emacs. + + 2) The caml include files are found under /usr/lib/ocaml//caml. + A symlink is provided from /usr/include/caml for convenience. If + /usr/include/caml was previously a directory, for whatever reason, a warning + will be issued and the file moved to /usr/include/caml.bad. This can be + safely erased later on. + + 3) User-installed stuff should not go under /usr/lib/ocaml/, + but rather under /usr/local/lib/ocaml/. + We will take no responsibility for people who break this rule and mess things + up. + + 4) Starting from OCaml 3.05, all dll.so files are now put into a common + stublibs directory, so the ocaml-ldconf tool for handling the ld.conf + file is not needed anymore, but we will still keep it around until all + libraries are ported. As of OCaml 3.08, ocaml-ldconf is now deprecated + and not available anymore. + Notice that user-installed dll.so files should go into + /usr/local/lib/ocaml//stublibs which is searched before + /usr/lib/ocaml//stublibs. + + -- Ralf Treinen , Fri, 15 Jul 2016 22:08:59 +0200 + +ocamldoc's LaTeX output +----------------------- + +ocamldoc can generated documentation in LaTeX format which can be later on +compiled using a LaTeX environment. The LaTeX sources generated by ocamldoc +exploits the fullpage.sty style, which is not included in a default texlive +installation (the Debian LaTeX environment of choice). + +In order to be able to compile ocamldoc generated LaTeX sources you will need +to install the "texlive-latex-extra" package. + + -- Stefano Zacchiroli Sun, 02 Sep 2007 18:22:14 +0200 + +Debug information produced by ocamlc +==================================== + +In upstream OCaml, “ocamlc -custom” produces executables that cannot +be stripped (more precisely, the bytecode, which is not part of the +ELF data, is removed by strip). This Debian version is patched (and +the patch has been rejected by upstream [1], but is available +separately in debian/patches) so that the bytecode is embedded in the +executable and can be stripped. This new behaviour is optional, and +can be enabled by setting the OCAML_CUSTOM_EMBED environment variable +to “y”. + +[1] http://bugs.debian.org/cgi-bin/bugreport.cgi?msg=49;bug=256900 + + -- Stéphane Glondu , Tue, 26 Jun 2012 07:27:05 +0200 diff --git a/debian/README.Debian b/debian/README.Debian deleted file mode 100644 index 7a63ebce..00000000 --- a/debian/README.Debian +++ /dev/null @@ -1,15 +0,0 @@ -OCaml Debian package -==================== - -In upstream OCaml, “ocamlc -custom” produces executables that cannot -be stripped (more precisely, the bytecode, which is not part of the -ELF data, is removed by strip). This Debian version is patched (and -the patch has been rejected by upstream [1], but is available -separately in debian/patches) so that the bytecode is embedded in the -executable and can be stripped. This new behaviour is optional, and -can be enabled by setting the OCAML_CUSTOM_EMBED environment variable -to “y”. - -[1] http://bugs.debian.org/cgi-bin/bugreport.cgi?msg=49;bug=256900 - - -- Stéphane Glondu , Tue, 26 Jun 2012 07:27:05 +0200 diff --git a/debian/ocaml-base-nox.README.Debian b/debian/ocaml-base-nox.README.Debian deleted file mode 100644 index cda8aafe..00000000 --- a/debian/ocaml-base-nox.README.Debian +++ /dev/null @@ -1,54 +0,0 @@ -OCaml for Debian ----------------- - - 1) The OCaml package has been split into different binary packages: - - o ocaml: contains the full OCaml suite - o ocaml-nox: the full suite except for the Graphics and Tk modules - o ocaml-base: contains the runtime stuff (ocamlrun + dlls + Tk) - o ocaml-base-nox: contains the runtime stuff (ocamlrun + dlls - Tk) - - o ocaml-compiler-libs: contains several modules used internally by - the OCaml compilers. They are not needed for normal OCaml - development, but may be helpful in the development of certain - applications. - o ocaml-source: contains the full OCaml source for the (few) packages which - need them at build time or for personal use (it should _not_ be used to - build OCaml itself). - - o ocaml-mode: contains a major mode for editing OCaml files in Emacs. - - 2) The caml include files are found under /usr/lib/ocaml//caml. - A symlink is provided from /usr/include/caml for convenience. If - /usr/include/caml was previously a directory, for whatever reason, a warning - will be issued and the file moved to /usr/include/caml.bad. This can be - safely erased later on. - - 3) User-installed stuff should not go under /usr/lib/ocaml/, - but rather under /usr/local/lib/ocaml/. - We will take no responsibility for people who break this rule and mess things - up. - - 4) Starting from OCaml 3.05, all dll.so files are now put into a common - stublibs directory, so the ocaml-ldconf tool for handling the ld.conf - file is not needed anymore, but we will still keep it around until all - libraries are ported. As of OCaml 3.08, ocaml-ldconf is now deprecated - and not available anymore. - Notice that user-installed dll.so files should go into - /usr/local/lib/ocaml//stublibs which is searched before - /usr/lib/ocaml//stublibs. - - -- Ralf Treinen , Fri, 15 Jul 2016 22:08:59 +0200 - -ocamldoc's LaTeX output ------------------------ - -ocamldoc can generated documentation in LaTeX format which can be later on -compiled using a LaTeX environment. The LaTeX sources generated by ocamldoc -exploits the fullpage.sty style, which is not included in a default texlive -installation (the Debian LaTeX environment of choice). - -In order to be able to compile ocamldoc generated LaTeX sources you will need -to install the "texlive-latex-extra" package. - - -- Stefano Zacchiroli Sun, 02 Sep 2007 18:22:14 +0200 diff --git a/debian/ocaml-base-nox.docs b/debian/ocaml-base-nox.docs index 52e22424..dd2b95c6 100644 --- a/debian/ocaml-base-nox.docs +++ b/debian/ocaml-base-nox.docs @@ -1 +1,2 @@ +debian/OCaml_for_Debian README.adoc diff --git a/debian/rules b/debian/rules index ebd129ee..718a4e60 100755 --- a/debian/rules +++ b/debian/rules @@ -206,12 +206,6 @@ endif cp tools/$$u debian/ocaml-nox/usr/bin/ocaml$$u; \ fi \ done - set -e; for pkg in ocaml ocaml-nox ocaml-base; do ( \ - mkdir -p debian/$$pkg/usr/share/doc/$$pkg && \ - cd debian/$$pkg/usr/share/doc/$$pkg && \ - ln -sf ../ocaml-base-nox/README.gz . && \ - ln -sf ../ocaml-base-nox/README.Debian .; \ - ); done endif # Remaining stuff touch $@ @@ -269,7 +263,8 @@ endif .PHONY: override_dh_installdocs override_dh_installdocs: - dh_installdocs --ignore debian/README.Debian + dh_installdocs --package=ocaml-base-nox --doc-main-package=ocaml + dh_installdocs --remaining-packages .PHONY: override_dh_missing override_dh_missing: