[28394] in Source-Commits

home help back first fref pref prev next nref lref last post

debathena-thirdparty commit: Add BUILDING file for documentation

daemon@ATHENA.MIT.EDU (Jonathan D Reed)
Wed Aug 13 08:45:15 2014

Date: Wed, 13 Aug 2014 08:45:05 -0400
From: Jonathan D Reed <jdreed@MIT.EDU>
Message-Id: <201408131245.s7DCj5BC012747@drugstore.mit.edu>
To: source-commits@MIT.EDU

https://github.com/mit-athena/debathena-thirdparty/commit/c54d5693dcefbff917c2a6258d1a7a0965696824
commit c54d5693dcefbff917c2a6258d1a7a0965696824
Author: Jonathan Reed <jdreed@mit.edu>
Date:   Wed Aug 13 08:37:54 2014 -0400

    Add BUILDING file for documentation
    
    Fully document the list syntax in the BUILDING file, and update
    the comment in lists/common to point there.

 BUILDING         |   34 ++++++++++++++++++++++++++++++++++
 debian/changelog |    3 ++-
 lists/common     |    6 +++---
 3 files changed, 39 insertions(+), 4 deletions(-)

diff --git a/BUILDING b/BUILDING
new file mode 100644
index 0000000..85fe4ef
--- /dev/null
+++ b/BUILDING
@@ -0,0 +1,34 @@
+This package uses plain text lists of package names to generate
+per-distro, per-architecture packages for debathena-thirdparty:
+
+lists/common: Common package list
+lists/$(lsb_release -sc): Per-distro amendments to the common list
+
+The lists files have a specific syntax:
+Line                            Meaning
+----                            -------
+packagename                     Depend on packagename
+packagename otherpackage        Depend packagename and otherpackage
+                                but remove otherpackage if packagename
+                                cannot be installed (useful for, e.g.
+                                not installing helper applications if
+                                the real application isn't there)
+package1 | package2             Depend on package1 or package2.  Unlike
+                                dpkg syntax, will only short-circuit
+                                from the left (package2 will not be
+                                checked unless package1 has no
+                                installation candidate)
+?packagename                    Recommend package name
+#something                      A comment (will be ignored)
+
+The lists files for specific codenames have a slight variation on the
+above syntax.
+Note: conditional (|) is not accepted in distro-specific files
+
++packagename                    Depend on packagename, even if it
+                                cannot be found in the APT cache
+                                (use with care)
+-packagename                    Remove packagename entirely (it may
+                                still be pulled in if something else
+                                depends on it, but this package will
+                                neither Depend nor Recommend it)
diff --git a/debian/changelog b/debian/changelog
index 56780c1..3f7e34c 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,8 +1,9 @@
 debathena-thirdparty (1.2.6) UNRELEASED; urgency=low
 
   * Add avogadro (Trac: #1510)
+  * Add BUILDING file to document how to build this package
 
- -- Jonathan Reed <jdreed@mit.edu>  Wed, 13 Aug 2014 08:30:09 -0400
+ -- Jonathan Reed <jdreed@mit.edu>  Wed, 13 Aug 2014 08:37:45 -0400
 
 debathena-thirdparty (1.2.5.2) unstable; urgency=low
 
diff --git a/lists/common b/lists/common
index 14a090c..77b7371 100644
--- a/lists/common
+++ b/lists/common
@@ -1,7 +1,7 @@
 # Thirdparty common file list
-# Packages listed here will be installed if available
-# Preceeding the package name with a question mark (?foo)
-# means that failing to install that package is not a fatal error
+#
+# See BUILDING for syntax
+#
 #debathena-thirdparty-accessories
 xtightvncviewer
 xcal

home help back first fref pref prev next nref lref last post