Bug#668027: ocaml-batteries-included: Lots of mismatches between what the documentation says and what the package does.
Package: ocaml-batteries-included
Version: 1.4.1-1
Severity: important
The documentation included in libbatteries-ocaml-doc does not correspond
to what the libraries actually do, and what the packages contain: it really
needs a thorough check.
Please do not underestimate the importance of fixing "just some documentation":
in the current state, a developer will simply not find a way to use these packages,
unless he/she has a friend in the Batteries developer's team.
A few examples:
/usr/share/doc/libbatteries-ocaml-doc/html/setup.html says:
To use batteries in the ocaml toplevel, install ocamlinit from the batteries source directory into your ~/.ocamlinit file and launch ocaml normally
but there is no ocamlinit to be found in any of the three batteries packages
/usr/share/doc/libbatteries-ocaml-doc/html/toplevel.html says:
To launch the toplevel from a terminal, open a terminal and write ocamlfind batteries/ocaml
but here is what happens if one tries
ocamlfind: Cannot find command: /usr/lib/ocaml/batteries/ocaml
/usr/share/doc/libbatteries-ocaml-doc/html/extensions.html says:
"where" construction (activated by default, implemented as findlib package batteries.pa_where.syntax)
but there is no findlib package batteries.pa_where.syntax to be found on the system!
-- System Information:
Debian Release: 6.0.1
APT prefers testing
APT policy: (760, 'testing'), (700, 'stable'), (600, 'unstable'), (550, 'experimental'), (500, 'stable-updates')
Architecture: amd64 (x86_64)
Kernel: Linux 2.6.38-1-amd64 (SMP w/8 CPU cores)
Locale: LANG=en_US.UTF-8, LC_CTYPE=en_US.UTF-8 (charmap=UTF-8) (ignored: LC_ALL set to en_US.utf8)
Shell: /bin/sh linked to /bin/dash
Versions of packages ocaml-batteries-included depends on:
ii libbatteries-ocaml-dev [libba 1.4.1-1+b1 Batteries included: OCaml developm
ii libbatteries-ocaml-doc 1.4.1-1 Batteries included - OCaml develop
ocaml-batteries-included recommends no packages.
ocaml-batteries-included suggests no packages.
-- no debconf information
Reply to: