summaryrefslogtreecommitdiffstats
path: root/specs/spf-2.0/metadata.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'specs/spf-2.0/metadata.mdwn')
-rw-r--r--specs/spf-2.0/metadata.mdwn26
1 files changed, 26 insertions, 0 deletions
diff --git a/specs/spf-2.0/metadata.mdwn b/specs/spf-2.0/metadata.mdwn
index 90e88fa..1195826 100644
--- a/specs/spf-2.0/metadata.mdwn
+++ b/specs/spf-2.0/metadata.mdwn
@@ -38,6 +38,32 @@ field must follow the syntax of the `mailbox` symbol of RFC 5322 section 3.4.
`date-time` symbol of RFC 5322 section 3.3.
+Source Package Documentation File List [docs]
+=============================================
+
+One binary package built from a source package provides documentation files
+about the source package. This binary package is identified by the presence of
+a `<binpkg>.pkg/docs` file, where `<binpkg>` is the name of the binary package.
+
+All other binary packages built from the same source package must declare a hard
+run-time dependency (either `Depends` or `Pre-Depends`) on this binary package.
+
+At least the `copyright` and `changelog` files are provided by the binary
+package. If found in the source package directory, a file named `README` is
+also provided.
+
+Additional documentation files may be listed in `<binpkg>.pkg/docs`. Each file
+must be identified with an entry of the following format:
+
+ source destination
+
+`source` is the path to the file, relative to the build work area (see
+$[sectlink][work-area]).
+
+`destination` is the path to which the file should be installed, relative to the
+source package documentation directory in the user's filesystem hierarchy.
+
+
Platform Configuration File Lists [platconf]
============================================