[Debian-astro-commits] [cspice] 31/48: Document the packaging

[Rock Storm]

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

rockstorm-guest pushed a commit to branch debian
in repository cspice.

commit 64fc2c0b76499c40c7e4fa5aa0a36907b850ddb6
Author: Rock Storm <rockstorm at gmx.com>
Date:   Fri Nov 18 21:21:41 2016 +0100

    Document the packaging
---
 debian/CONTRIBUTING.md | 12 ++++++++++++
 debian/README.Debian   | 20 +++++++++++++++++---
 debian/README.source   |  4 ++--
 3 files changed, 31 insertions(+), 5 deletions(-)

diff --git a/debian/CONTRIBUTING.md b/debian/CONTRIBUTING.md
new file mode 100644
index 0000000..52275c4
--- /dev/null
+++ b/debian/CONTRIBUTING.md
@@ -0,0 +1,12 @@
+Git Repository Layout
+=====================
+
+This package is maintained using git with the following branch layout:
+
+ * "upstream" branch: contains the pristine contents extracted from upstream's "tarball".
+ 
+ * branch "dfsg": branches from "upstream" and includes the necessary changes to make it comply with the DFSG. Every finished repackaging is tagged "upstream/<upstrem-version>+dfsg". This tag is needed for building with gpb-buildpackage.
+ 
+ * branch "debian": contains only changes made to the debian folder. This is the branch that is suppossed to be checked out to call gbp-buildpackage from.
+ 
+ * brach "master": no use yet.
\ No newline at end of file
diff --git a/debian/README.Debian b/debian/README.Debian
index 3fcef78..b9c8ee0 100644
--- a/debian/README.Debian
+++ b/debian/README.Debian
@@ -1,6 +1,20 @@
-cspice for Debian
-----------------
+General Information
+===================
 
-<possible notes regarding this package - if none, delete this file>
+The contents the CSPICE package is split into four packages in the following manner:
+
+ * libcspice1: only contains the SPICE library, distributed as a shared library so it can be linked against.
+
+ * libcspice-dev: contains all the necessary tools to develop applications using the SPICE library. The latter is now distributed as a static library, along with the header files and libcspice.so.
+
+ * cspice: contains mainly the utilities for which upstream has released the source code, a.k.a. the SPICE Toolkit. Also, some example or "cookbook" programs to demonstrate the capabilities of the spice library along with example data can be found in the directory /usr/share/doc/cspice/examples.
+
+ * cspice-doc: contains all the documentation for the library and the Toolkit utilities, in both text and html format. This documentation can be found in the directory /usr/share/doc/cspice once this package is installed. Upstream provides numerous additional tutorials and training lessons that can be found at http://naif.jpl.nasa.gov/naif/tutorials.html.
+
+
+Why is csupport not distributed? Where is "libcsupport"?
+========================================================
+
+While upstream guarantees backwards compatibility for the SPICE library, that won't be the case for the csupport library. Also, users are kindly asked not to use this library. See /usr/share/doc/cspice/dscriptn.txt.
 
  -- Rock Storm <rockstorm at gmx.com>  Wed, 19 Oct 2016 17:43:24 +0200
diff --git a/debian/README.source b/debian/README.source
index 4c120e7..42d78cf 100644
--- a/debian/README.source
+++ b/debian/README.source
@@ -1,10 +1,10 @@
 cspice for Debian
 ----------------
 
+Upstream releases different binaries and slightly different code for 32 and 64 bit machines. This Debian package is constructed from the 32 bit version by tweaking the code and rewritting the building sequence. See the patches placed in debian/patches and the debian/Makefile.
+
 <this file describes information about the source package, see Debian policy
 manual section 4.14. You WILL either need to modify or delete this file>
 
-
-
  -- Rock Storm <rockstorm at gmx.com>  Wed, 19 Oct 2016 17:43:24 +0200
 

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