The following commit has been merged in the master branch:
commit eeb969b7adf3ed6ebfe3667a0cec16ca1b2044a0
Author: Ralf Treinen <trei...@free.fr>
Date:   Thu Jan 19 20:46:33 2012 +0100

    fix some typos in coinst.1, add reference to the paper.

diff --git a/debian/manpages/coinst.1 b/debian/manpages/coinst.1
index f21b1ff..14ced78 100644
--- a/debian/manpages/coinst.1
+++ b/debian/manpages/coinst.1
@@ -8,9 +8,9 @@ Coinst \- computes the co-installability kernel of a package 
repostory
 
 .SH DESCRIPTION
 .B coinst
-reads a package repository in debian format or RPM format
-from standard input, and computes the co-installability kernel of the
-repository (see below). The graph of the kernel is written in dot 
+reads a package repository in debian format or RPM format from
+standard input, and computes the co-installability kernel of the
+repository (see below). The graph of the kernel is written in dot
 format to a file, and a diagnostic is written to standard output. This
 diagnostic consists by default of:
 .RS 2
@@ -23,33 +23,36 @@ the list of not co-installable pairs of packages
 .RE
 
 .SH CO-INSTALLABILITY KERNELS
-A set of packages is called co-installable if it can be extended to a
-set that satisfies all inter-package relations (dependencies,
-conflicts, etc.). In particular, a package p is installable if the set
-{p} consisting of p only is co-installable.
-
-This tool reduces a repository to a much smaller
-one, its so-called co-installability kernel, that behaves exactly the
-same as far as co-installability of package is concerned. This is
-achieved by
+A set of packages is called co-installable with respect to a
+repository R if it can be extended to a set of packages from R that
+satisfies all inter-package relations (dependencies, conflicts,
+etc.). In particular, a package p is installable if the set {p}
+consisting of p only is co-installable.
+
+This tool reduces a repository R to a much smaller one, its so-called
+co-installability kernel R', that behaves exactly the same as far as
+co-installability of package is concerned: Any set of packages P is
+co-installable with respect to P iff it co-installable with respect to
+R'. This is achieved by
 .RS 2
 .IP "\-" 2
-dropping all relations that are not relevant for this purpose. For instance,
-dependencies that do not lead directly or indirectly to any conflicts are
-dropped.
+dropping all relations that are not relevant for this purpose. For
+instance, dependencies that do not lead directly or indirectly to any
+conflicts are dropped.
 .IP "\-" 2
-identifying all packages that behave the same. For instance, packages that are
-not in conflict with any other package (even not through dependency chains)
-behave the same since they are co-installable with any other installable
-package, and packages that are not installable at all behave the same
-since they are co-installable with no package.
+identifying all packages that behave the same. For instance, packages
+that are not in conflict with any other package (even not through
+dependency chains) behave the same since they are co-installable
+together with any other co-installable set of packages, and packages
+that are not installable at all behave the same since they may never be
+part of any co-installable set of packages.
 .RE
 
 A more precise explanation can be found in the original research article
 underlying this tool.
 
-The kernel
-is typically orders of magnitude smaller than the original repository.
+The interest of computing the kernel is that it is typically orders of
+magnitude smaller than the original repository.
 
 .SH OPTIONS
 
@@ -78,22 +81,42 @@ draw only the relevant portion of the graph around package 
\fIp\fR.
 .SS Options controlling the diagnostic output
 .TP
 .B \-explain
-explain the list of non-installable pairs of not co-installable
-packages.
+explain the list of non-installable pairs of packages.
 .TP
 .B \-stats
-Show statistics regarding the input and output repositories
+show statistics regarding the input and output repositories
 
 .SS Miscellaneous options
 .TP
 .B \-help, \-\-help
 show command synopsis
 
+.SH EXAMPLE
+Reduce a current debian Packages file to its kernel:
+
+   coinst -all -o raw.dot < sid_main_binary-amd64_Packages
+
+Layout the graph:
+
+   dot raw.dot -o layout.dot:
+
+View the graph with dotty, or the viewer from the coinst_viewer package:
+
+   dotty layout.dot
+   coinst_viewer layout.dot
+
 .SH AUTHOR
 Coinst has been written by Jérome Vouillôn.  This manpage has been
 compiled by Ralf Treinen from the original coinst documentation.
 
 .SH SEE ALSO
-.BR dot (1), coinst_viewer (1)
+.BR dot (1), dotty(1), coinst_viewer (1)
 .br
 .I http://coinst.irill.org
+.br
+The original research article decribing the algorithm behind this tool
+is Roberto Di Cosmo and Jérôme Vouillon, \fIOn software component
+co-installability\fR, 19th ACM SIGSOFT Symposium on the Foundations of
+Software Engineering (FSE-19) and ESEC'11: 13rd European Software
+Engineering Conference (ESEC-13), Szeged, Hungary, September 5-9, 2011,
+pages 256-266.

-- 
coinst packaging

_______________________________________________
Pkg-ocaml-maint-commits mailing list
Pkg-ocaml-maint-commits@lists.alioth.debian.org
http://lists.alioth.debian.org/cgi-bin/mailman/listinfo/pkg-ocaml-maint-commits

Reply via email to