summaryrefslogtreecommitdiffstats
path: root/specs
diff options
context:
space:
mode:
authorP. J. McDermott <pjm@nac.net>2012-02-25 17:00:24 (EST)
committer P. J. McDermott <pjm@nac.net>2012-02-25 17:00:24 (EST)
commit466f8a23ba286125eeb357753600ccffea8fe83b (patch)
tree6c920fd886a65eec792cf2cce70360682b48151c /specs
parentea0d945b800e10ab5f0642ff84e86a8aeee4b705 (diff)
Document the configuration file list format.
Diffstat (limited to 'specs')
-rw-r--r--specs/source-package-format-1.0.txt25
1 files changed, 25 insertions, 0 deletions
diff --git a/specs/source-package-format-1.0.txt b/specs/source-package-format-1.0.txt
index 3fa28dd..a9c3831 100644
--- a/specs/source-package-format-1.0.txt
+++ b/specs/source-package-format-1.0.txt
@@ -155,6 +155,31 @@ The fields in the source package metadata are:
by angle brackets or any other characters.
+Configuration File List Format
+==============================
+
+Platform-specific configuration files used by the source package at build time
+or by the binary package(s) at run time should be listed in the file 'config'.
+
+Each file must be described with an entry of the following format:
+ type source destination
+
+"type" is the string "buildtime" for a file used at build time or "runtime" for
+a file used at run time.
+
+"source" is the path to the file, relative to the platform configuration
+directory -- either `/usr/share/config/PLATFORM/PACKAGE-VERSION` or
+`/usr/share/config/PLATFORM/PACKAGE`, where "PLATFORM" is the architcture string
+denoting an application platform, "PACKAGE" is the name of the configurable
+source package, and "VERSION" is the upstream version of the configurable source
+package.
+
+"destination" is the path (file or directory) to which the file should be
+copied. For a file used at build time, it is a path relative to the package
+building work area. For a file used at run time, it is an absolute path in the
+user's filesystem hierarchy.
+
+
Change Log Format
=================