From 2132d25f3a2f04af123ec20cbd15eee741638ffc Mon Sep 17 00:00:00 2001 From: P. J. McDermott Date: Fri, 12 Oct 2012 18:39:02 -0400 Subject: Document the docs file in SPF 2.0. --- (limited to 'specs/spf-2.0/overview.mdwn') diff --git a/specs/spf-2.0/overview.mdwn b/specs/spf-2.0/overview.mdwn index 1895815..9dcdda0 100644 --- a/specs/spf-2.0/overview.mdwn +++ b/specs/spf-2.0/overview.mdwn @@ -11,6 +11,10 @@ tree: | +- control | | Required. | | Metadata about the binary package. + | +- docs + | | Required for exactly one binary package. + | | A list of source package documentation files to be provided by + | | the package. | +- platconf | | Optional. | | A list of run-time configuration files. @@ -85,6 +89,16 @@ This file contains control fields describing the binary package. See $[sectlink][control] for the syntax of this file and $[sectlink][fields-bin] for the list of control fields in this file. +`.pkg/docs` [files-binpkg.pkg-docs] +------------------------------------------- + +This file is required for exactly one binary package. + +This file contains a list of source package documentation files to be provided +by the binary package. + +See $[sectlink][docs] for more information about this file. + `.pkg/platconf` [files-binpkg.pkg-platconf] --------------------------------------------------- -- cgit v0.9.1