From cb44dbe27f3366f7c019d2f2e26b8e9579fa265f Mon Sep 17 00:00:00 2001
From: P. J. McDermott <pjm@nac.net>
Date: Mon, 13 Aug 2012 22:19:11 -0400
Subject: Finish moving SPF 2.0 into a book.

Omitted (at least temporarily) are "Packaging Recommendations" and
"Example Files".
---
(limited to 'specs/spf-2.0/fields.mdwn')

diff --git a/specs/spf-2.0/fields.mdwn b/specs/spf-2.0/fields.mdwn
new file mode 100644
index 0000000..51a9415
--- /dev/null
+++ b/specs/spf-2.0/fields.mdwn
@@ -0,0 +1,90 @@
+Source Package Fields [fields-src]
+==================================
+
+The fields in the source package metadata are:
+
+  * `Maintainer` (required)  
+
+    The name and e-mail address of the package maintainer.  This field must
+    follow the syntax of the `mailbox` symbol in RFC 5322 section 3.4.
+
+  * `Build-Depends` (optional)  
+
+    A list of packages that must be installed before the package can be built.
+
+  * `Homepage` (optional)  
+
+    The URL of the Web site for the package.  Accessible at this site should be
+    origin source code and documentation and/or information.  Though the
+    information in this field is machine-usable, the URL must not be surrounded
+    by angle brackets or any other characters.
+
+
+Binary Package Fields [fields-bin]
+==================================
+
+The fields in the binary package metadata are:
+
+  * `Architecture` (required)  
+
+    A list of architectures for which this package may be built.  The value may
+    be any one of the following:
+
+    - The string `all` to specify that all of the provided files are
+      architecture-independent;
+    - The string `any` to specify that at least some of the provided files are
+      architecture-dependent; or
+    - A space-separated list of one or more real or wildcard binary architecture
+      strings to specify that at least some of the provided files are only
+      usable on systems of the named binary architecture(s).
+
+    A "wildcard" binary architecture string is one in which one or two
+    components (called "wildcard components") is the string `any`.  It shall be
+    considered to match any real binary architecture string for which the
+    non-wildcard components are equal.
+
+  * `Platform` (required)
+
+    A list of platforms for which this package may be built.  The value may be
+    any one of the following:
+
+    - The string `all` to specify that all of the provided files are
+      platform-independent;
+    - The string `any` to specify that at least some of the provided files are
+      platform-dependent; or
+    - A space-separated list of one or more platform strings to specify that at
+      least some of the provided files are only usable on systems of the named
+      platform(s).
+
+  * `Essential` (optional)  
+
+    A flag to indicate whether the package is essential for the functioning of a
+    system on which it is installed.  If this field is set to `yes`, opkg will
+    refuse to remove the package except when upgrading it.  If this field is set
+    to any other value or is omitted, the package may be removed by a user.
+
+  * `Depends` (optional)  
+
+    A list of packages that must be installed and configured before the package
+    may itself be configured.
+
+  * `Recommends` (optional)  
+
+  * `Suggests` (optional)  
+
+  * `Pre-Depends` (optional)  
+
+    A list of packages that must be installed before the package may itself be
+    installed.
+
+  * `Conflicts` (optional)  
+
+  * `Provides` (optional)  
+
+  * `Replaces` (optional)  
+
+  * `Description` (required)  
+
+    A description of the binary package.  This is a multiline field.  The first
+    line is a short synopsis, and all following lines are an extended
+    description.
--
cgit v0.9.1