[petsc] 01/01: document petsc alternatives in README.Debian

[Drew Parsons]

This is an automated email from the git hooks/post-receive script.

dparsons pushed a commit to branch master
in repository petsc.

commit 05dd5cfff6866cb27966daf7ecd0b33892200da3
Author: Drew Parsons <dparsons at debian.org>
Date:   Fri Jun 3 17:55:14 2016 +0800

    document petsc alternatives in README.Debian
---
 debian/README.Debian | 66 +++++++++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 58 insertions(+), 8 deletions(-)

diff --git a/debian/README.Debian b/debian/README.Debian
index 7151753..8c8ed86 100644
--- a/debian/README.Debian
+++ b/debian/README.Debian
@@ -5,23 +5,29 @@
 INTRODUCTION
 
 This source package is distributed in five binary packages: the shared
-libraries are in libpetsc3.6; header files, static libraries  and important 
-files for building examples are in libpetsc3.6.4-dev, this also sets up 
-various alternatives links; debugging libraries are in libpetsc3.6.4-dbg; 
-extensive documentation and source code from "tests" and "tutorials" 
+libraries are in libpetsc3.6; header files, static libraries  and important
+files for building examples are in libpetsc3.6.4-dev, this also sets up
+various alternatives links; debugging libraries are in libpetsc3.6.4-dbg;
+extensive documentation and source code from "tests" and "tutorials"
 directories are in petsc3.6.4-doc.
 
-Standard packages are configured for real numbers.  Complex numbers are 
-configured in the libpetsc-complex* packages. The preferred default 
+Standard packages are configured for real numbers.  Complex numbers are
+configured in the libpetsc-complex* packages. The preferred default
 configuration may be set using alternatives (petsc and libpetsc.so.3.6).
 
 The preferred PETSc installation is located at /usr/lib/petsc. This is a symlink
 to the actual installation, managed by Debian alternatives (see below). The
-standard installation is located at 
+standard installation is located at
   /usr/lib/petscdir/<PETSC_VERSION>/<arch>
 e.g.
   /usr/lib/petscdir/3.6.4/x86_64-linux-gnu
 
+Preferred minor patch versions of each major version (e.g. 3.6)
+are linked via
+  /usr/lib/petscdir/3.6
+(also, preferred versions of 3.6-real and 3.6-complex). These links are
+controlled by alternatives.
+
 libpetsc.so is also controlled by alternatives (libpetsc.so.3.6)
 
 
@@ -137,13 +143,57 @@ links if you have multiple versions of PETSc installed.  The command:
 there is more than one.
 
 When setting your preference for /usr/lib/petsc via "update-alternatives --config petsc",
-it is important for consistency to also update your preference for the 
+it is important for consistency to also update your preference for the
 main shared library files provided by libpetsc3.6 or libpetsc-complex-3.6.
 These alternative links are controlled by libpetsc.so.3.6:
 
 	update-alternatives --config libpetsc.so.3.6
 
+The preferred alternative for the major petsc version (e.g. 3.6) is linked in
+/usr/lib/petscdir/3.6 and set by
+
+	update-alternatives --config petsc3.6
+
+Alternatives are similarly available for petsc3.6-real and petsc3.6-complex
+
 To maintain the consistency of the master and slave symlinks, it is very
 important that you use the Debian update-alternatives command, and do NOT
 hand-edit the symbolic links yourself.
 
+The full set of PETSc alternatives is:
+
+petsc	- set the default version (real or complex) of PETSc (/usr/lib/petsc)
+
+libpetsc_real.so
+	- set the default PETSc shared library with real number support
+
+libpetsc_complex.so
+	- set the default PETSc shared library with complex number support
+
+petsc3.6
+	- set the preferred minor patch version (real or complex) of PETSc 3.6
+	  (/usr/lib/petscdir/3.6)
+
+petsc3.6-real
+	- set the preferred minor patch version of PETSc 3.6 
+	  with real number support (/usr/lib/petscdir/3.6-real)
+
+petsc3.6-complex	
+	- set the preferred minor patch version of PETSc 3.6 
+	  with complex number support (/usr/lib/petscdir/3.6-complex)
+
+libpetsc.so.3.6 
+	- set the preferred minor patch version (real or complex) for the 
+	  shared library of PETSc 3.6
+
+libpetsc_real.so.3.6
+	- set the preferred minor patch version for the shared library
+	  of PETSc 3.6 with real number support
+
+libpetsc_complex.so.3.6
+	- set the preferred minor patch version for the shared library
+	  of PETSc 3.6 with complex number support
+
+(likewise for other major versions in place of 3.6)
+   
+ -- Drew Parsons <Drew Parsons <dparsons at debian.org>>, Fri,  3 Jun 2016 17:37:29 +0800

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/petsc.git