summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorP. J. McDermott <pjm@nac.net>2012-10-08 16:07:17 (EDT)
committer P. J. McDermott <pjm@nac.net>2012-10-08 16:07:17 (EDT)
commit1ef3edeb379ead2a2f9bffe4a876b9ffbfbcab57 (patch)
tree4372a73329d082c7ab734646901bbaf92deddb24
parent2e8afcfd8d4506989ff6a93b435f19aa4f5367ca (diff)
Document the upstream source archive.
-rw-r--r--specs/spf-2.0/overview.mdwn19
1 files changed, 17 insertions, 2 deletions
diff --git a/specs/spf-2.0/overview.mdwn b/specs/spf-2.0/overview.mdwn
index 71f77a3..820224d 100644
--- a/specs/spf-2.0/overview.mdwn
+++ b/specs/spf-2.0/overview.mdwn
@@ -184,10 +184,25 @@ building any binary packages.
See $[sectlink][patches] for the syntax of patch files.
-`<pkgname>-<pkgver>.orig.tar.<ext>` [files-src-src-ver-tar-ext]
+`<pkgname>-<pkgver>.orig.tar<ext>` [files-src-src-ver-tar-ext]
----------------------------------------------------------
-TODO
+This file is optional. `<pkgname>` is the name of the source package,
+`<pkgver>` is the upstream version of the source package (see
+$[sectlink][src-ver]), and `<ext>` is an optional file extension to indicate
+compression.
+
+This file is a tar archive containing the source files for non-native packages.
+There must be exactly one top-level directory in the archive.
+
+The file may be compressed, in which case `<ext>` must be one of the following:
+
+ * `.gz` for the "gzip" algorithm,
+ * `.bz2` for the "bzip2" algorithm,
+ * `.lz` for the "LZMA" algorithm, or
+ * `.Z` for the "compress" algorithm.
+
+If the file is not compress, `<ext>` must be empty.
`platconf` [files-platconf]
---------------------------