From c2df77fb4f53916119197d681374a2ca039a0e24 Mon Sep 17 00:00:00 2001 From: P. J. McDermott Date: Sun, 26 Aug 2012 17:51:11 -0400 Subject: Move documentation of install files to Metadata. --- (limited to 'specs/spf-2.0') diff --git a/specs/spf-2.0/metadata.mdwn b/specs/spf-2.0/metadata.mdwn index f5b08bd..67f99be 100644 --- a/specs/spf-2.0/metadata.mdwn +++ b/specs/spf-2.0/metadata.mdwn @@ -40,6 +40,27 @@ field must follow the syntax of the `mailbox` symbol of RFC 5322 section 3.4. `date-time` symbol of RFC 5322 section 3.3. +File Installation Lists [install] +================================= + +Binary packages that provide files shall have a file named `install` in their +`.pkg/` directories. + +The `.pkg/install` file is a list of patterns, terminated by line +breaks, to match files that are to be installed in the binary package. + +Each pattern shall be expanded to match files in the installation destination +directory (see $[sectlink][work-area]) as explained in [POSIX.1-2008, Shell & +Utilities Volume, Section 2.6.6][posix-xcu-2.6.6]. + +A file or directory in the installation destination directory shall not be +matched by the `install` file of more than one binary package. Any such case +shall be considered an error. + +Run-time platform configuration files listed in a binary package's `platconf` +file shall not be listed in the package's `install` file. + + Platform Configuration File Lists [platconf] ============================================ @@ -108,3 +129,6 @@ reset to `1` for the first upload to `` of a new upstream package version, source archive repack, or distribution packaging revision. It must be a string of one or more digits, the first of which must be greater than or equal to `1`. (A regular expression for this is `[1-9][0-9]*`.) + + +[posix-xcu-2.6.6]: http://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_06_06 diff --git a/specs/spf-2.0/overview.mdwn b/specs/spf-2.0/overview.mdwn index 26a34d3..de45ff0 100644 --- a/specs/spf-2.0/overview.mdwn +++ b/specs/spf-2.0/overview.mdwn @@ -101,12 +101,7 @@ This file is required. This file contains a list of patterns to match files to be installed in the binary package. -Each line in this file is a pattern that is expanded to match files as explained -in [POSIX.1-2008, Shell & Utilities Volume, Section 2.6.6][posix-xcu-2.6.6]. - -A file or directory in the destination directory may not be matched by more than -one binary package's `install` file. The behavior of package building tools in -such a case is undefined. +See $[sectlink][install] for more information about this file. `.pkg/platconf` [files-binpkg.pkg-platconf] --------------------------------------------------- @@ -115,8 +110,7 @@ This file is optional. Its presence indicates that a binary package is platform-specific. This file contains a list of run-time configuration files to be installed in the -binary package. Files listed in this file shall not be listed in the binary -package's `install` file. +binary package. See $[sectlink][platconf] for the syntax of this file. @@ -229,6 +223,3 @@ See $[sectlink][platconf] for the syntax of this file. ------------------ TODO - - -[posix-xcu-2.6.6]: http://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_06_06 -- cgit v0.9.1