[Pkg-ocaml-maint-commits] [SCM] ocaml-batteries packaging branch, master, updated. upstream/0.20090401-91-g4ec468c

[Stefano Zacchiroli]

The following commit has been merged in the master branch:
commit 4ec468c345d626866a1090ad7b517d66cf7a30f3
Author: Stefano Zacchiroli <zack at upsilon.cc>
Date:   Fri Apr 3 11:31:27 2009 +0200

    README.Debian: point to batteries-enabled command wrappers

diff --git a/debian/README.Debian b/debian/README.Debian
index b1feb77..ed71ea0 100644
--- a/debian/README.Debian
+++ b/debian/README.Debian
@@ -7,19 +7,42 @@ for more general Batteries documentation see the content of the
 `libbatteries-ocaml-doc' package.
 
 
+Using the Batteris toolchain
+----------------------------
+
+The usual tools composing the OCaml toolchain (ocamlc, ocamlopt,
+ocaml, ocamldep, ...) have "Batteries-enabled" equivalents which
+automatically load stuff specific to Batteries such as required
+libraries and (CamlP4) language extensions.
+
+The rule of thumb to access the Batteries-enabled toolchain is to
+invoke "ocamlfind batteries/COMMAND" to access the equivalent of
+COMMAND in the legacy toolchain. Under the hood that works because the
+commands are installed under `ocamlfind query batteries`. A full list
+of Batteries-enabled commands and how to invoke them is reported
+below:
+
+- ocamlfind batteries/ocaml		# interactive top-level
+- ocamlfind batteries/ocamlc		# (bytecode) compiler
+- ocamlfind batteries/ocamlcp		# profiler
+- ocamlfind batteries/ocamldep		# dependency generator
+- ocamlfind batteries/ocamlopt		# (native code) compiler
+
 Enhanced top-level `ocaml-batteries'
 ------------------------------------
 
 Batteries comes with an enhanced top-level (read-eval-print loop) with
 on-line help facilities. It is shipped in the Batteries library
-directory, but is also symlinked to `/usr/bin/ocaml-batteries' for
-your convenience. Just execute "ocaml-batteries" to get started, even
-though you might prefer to execute:
+directory and can be invoked as discussed above, but is also symlinked
+to `/usr/bin/ocaml-batteries' for your convenience. Just execute
+"ocaml-batteries" to get started, even though you might prefer to
+execute:
 
         ledit ocaml-batteries
 
 to enjoy line-editing capabilities. `ledit' comes with the `ledit'
-package; feel free to replace it with your favorite line-editor.
+package; feel free to replace it with your favorite line-editor (e.g.,
+rlwrap).
 
 Once inside the Batteries top-level, type
 
@@ -31,4 +54,4 @@ Note that, for the help system to work, you need to install the
 `libbatteries-ocaml-doc' package.
 
 
- -- Stefano Zacchiroli <zack at debian.org>, Tue, 11 Nov 2008 20:49:44 +0100
+ -- Stefano Zacchiroli <zack at debian.org>, Fri,  3 Apr 2009 11:30:38 +0200
diff --git a/debian/changelog b/debian/changelog
index 6ab1852..13d37c6 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -2,6 +2,7 @@ ocaml-batteries (0.20090401+git4CA4770-1) UNRELEASED; urgency=low
 
   * new upstream snapshot, commit 4CA4770
   * debian/rules: set archive sections to "ocaml" for lib*ocaml*
+  * README.Debian: point to batteries-enabled command wrappers
 
  -- Stefano Zacchiroli <zack at debian.org>  Thu, 02 Apr 2009 15:26:22 +0200
 

-- 
ocaml-batteries packaging