[Pkg-ocaml-maint-commits] [SCM] dose3 packaging branch, master, updated. debian/2.9.4-2-16-g689f51c

Sat Jun 11 10:07:19 UTC 2011

The following commit has been merged in the master branch:
commit c87be01fbc96229a51e2317164d1263de8c3febd
Author: Stefano Zacchiroli <zack at upsilon.cc>
Date:   Sat Jun 11 11:56:32 2011 +0200

    new upstream SVN snapshot, r2709

diff --git a/Makefile b/Makefile
index ae4955b..e320345 100644
--- a/Makefile
+++ b/Makefile
@@ -5,7 +5,7 @@ DIST_TARBALL = $(DIST_DIR).tar.gz
 
 OBFLAGS = -use-ocamlfind #-classic-display
 
-all: lib
+all: lib man
 	$(OCAMLBUILD) $(OBFLAGS) $(TARGETS)
 
 DOSELIBS = _build/doselibs
@@ -87,15 +87,20 @@ doseparse/boilerplateNoRpm.%:
 
 lib: $(LIBS)
 
+man: doc/manpages/apt-cudf.1
+
+doc/manpages/apt-cudf.1: doc/manpages/apt-cudf.pod
+	pod2man --section 8 --release "$(NAME) $(VERSION)" $< > $@
+
 clean:
 	$(OCAMLBUILD) -clean
 
 distclean: clean
 	rm -Rf Makefile.config aclocal.m4 config.log config.status autom4te.cache/
-	rm algo/algo.mlpack
-	rm common/versionInfo.ml
-	rm db/db.mlpack
-	rm META
+	rm -f algo/algo.mlpack
+	rm -f common/versionInfo.ml
+	rm -f db/db.mlpack
+	rm -f _tags META
 	rm -f doc/manpages/*.1
 
 $(DOSELIBS)/%:
diff --git a/debian/changelog b/debian/changelog
index 8bbe7c8..cd240d4 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,8 +1,8 @@
-dose3 (2.9.4+r2696-1) UNRELEASED; urgency=low
+dose3 (2.9.4+r2709-1) UNRELEASED; urgency=low
 
   [ Stefano Zacchiroli ]
-  * Imported Upstream version 2.9.4+r2696
-    - upstream SVN snapshot, release 2696
+  * Imported Upstream version 2.9.4+r2709
+    - upstream SVN snapshot, release 2709
     - contains apt-cudf
   * new binary package: apt-cudf
     - provides glue among CUDF solvers and EDSP (i.e. APT's native)
@@ -12,7 +12,7 @@ dose3 (2.9.4+r2696-1) UNRELEASED; urgency=low
     - set up trigger monitoring /usr/share/cudf/solvers/; it will invoke
       update-cudf-solvers at each change
 
- -- Stefano Zacchiroli <zack at debian.org>  Fri, 10 Jun 2011 15:45:43 +0200
+ -- Stefano Zacchiroli <zack at debian.org>  Sat, 11 Jun 2011 11:57:28 +0200
 
 dose3 (2.9.4-2) experimental; urgency=low
 
diff --git a/doc/apt-cudf/README.cudf-solvers b/doc/apt-cudf/README.cudf-solvers
index 371778d..88e371e 100644
--- a/doc/apt-cudf/README.cudf-solvers
+++ b/doc/apt-cudf/README.cudf-solvers
@@ -1,17 +1,19 @@
 CUDF solver specification
 =========================
 
-Several CUDF solvers can be installed at once on any given system.
+Several CUDF solvers may be installed at teh same time on any given
+system.
 
-Each solver must come together a "CUDF solver specification" file. CUDF solver
-specifications must be installed under `/usr/share/cudf/solvers/`, one file per
-solver.
+Each solver must come together a "CUDF solver specification" file. The
+CUDF solver specification files must be installed under
+`/usr/share/cudf/solvers/`, one file per solver.
 
-The CUDF solver specification file must carry the same name of the solver. CUDF
-solver names must be formed using only alphanumeric ASCII characters, dashes,
-and underscores; solver names must start with a lowercase ASCII letter. The
-special name `internal` is reserved (for APT internal solver) and shall not be
-used.
+The name of a CUDF solver specification file must be formed using only
+alphanumeric ASCII characters, dashes, and underscores, and must start
+with a lowercase ASCII letter. The special name `internal` is reserved
+(for the APT internal solver) and shall not be used. The name of this
+file may hence be used as a unique identifier of the solver it
+describes.
 
 A list of installed CUDF solvers can therefore be obtained by looking at the
 content of `usr/share/cudf/solvers`. E.g.:
@@ -33,10 +35,11 @@ Allowed properties are:
   corresponding CUDF solver
 
 - **exec:** (mandatory) command line that should be used to invoke the CUDF
-  solver meant to be interpreted, after interpolation, by `/bin/sh`. The
-  command line must contain 3 wildcards, each one occurring only once: "$in",
-  "$out", "$pref". All wildcards will be replaced before invoking the CUDF
-  solver as follows:
+  solver meant to be interpreted, after interpolation, by `/bin/sh` (warning:
+  that also means that no special treatment of shell meta characters is done,
+  you've been warned). The command line must contain 3 wildcards, each one
+  occurring only once: "$in", "$out", "$pref". All wildcards will be replaced
+  before invoking the CUDF solver as follows:
 
   - **$in:** file name of the input CUDF document for the solver. The file must
     be read sequentially by the solver only once and cannot be lseek()-ed;
@@ -52,7 +55,8 @@ Allowed properties are:
 - **cudf-version:** (mandatory) version of the CUDF standard supported by the
   CUDF solver
 
-A sample CUDF solver specification is given below:
+A sample CUDF solver specification, describing the solver 'ssolve',
+is given below:
 
         $ cat /usr/share/cudf/solvers/ssolve
         description: super solver that will blow your mind
diff --git a/doc/manpages/apt-cudf.pod b/doc/manpages/apt-cudf.pod
new file mode 100644
index 0000000..8dfc2af
--- /dev/null
+++ b/doc/manpages/apt-cudf.pod
@@ -0,0 +1,38 @@
+=head1 NAME
+
+apt-cudf - CUDF solver integration for APT
+
+=head1 SYNOPSIS
+
+=over
+
+=item B<solvername>
+
+=back
+
+=head1 DESCRIPTION
+
+apt-cudf translates back and forth among a CUDF-based dependency solver and the
+protocol used by APT to talk with external dependency solvers. apt-cudf
+therefore allows to use any CUDF solver as an external solver for APT.
+
+apt-cudf relies on its C<argv[0]> name to find the CUDF solver to invoke.  In
+common setups, you should have a CUDF solver specification file under
+F</usr/share/cudf/solvers/> for each installed CUDF solver. To use one such
+solver with APT, you should create a symbolic link pointing to
+F</usr/bin/apt-cudf> under F</usr/lib/apt/solvers/> and call it with the name
+of the CUDF solver you want to use.
+
+=head1 SEE ALSO
+
+apt-get(8), update-cudf-solvers(8),
+L<README.cudf-solvers|file:///usr/share/doc/apt-cudf/README.cudf-solvers>,
+L<README.Debian|file:///usr/share/doc/apt-cudf/README.Debian>
+
+=head1 AUTHOR
+
+Copyright: (C) 2011 Stefano Zacchiroli <zack at debian.org>
+
+License: GNU Lesser General Public License (GPL), version 3 or above
+
+=cut

-- 
dose3 packaging

