summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorP. J. McDermott <pjm@nac.net>2012-02-26 01:15:36 (EST)
committer P. J. McDermott <pjm@nac.net>2012-02-26 01:15:36 (EST)
commitf771d56609e81a66669632c7121a1ee8edde197d (patch)
treebb0c444715f37219a41b1acd2d0c7c9e0c324320
parent2795b58cfabfc4c126fb401e517c8c3436162e41 (diff)
Rearrange sections in source package format spec.
-rw-r--r--specs/source-package-format-1.0.txt168
1 files changed, 84 insertions, 84 deletions
diff --git a/specs/source-package-format-1.0.txt b/specs/source-package-format-1.0.txt
index f955595..2e15eea 100644
--- a/specs/source-package-format-1.0.txt
+++ b/specs/source-package-format-1.0.txt
@@ -148,12 +148,96 @@ multiple binary package configuration.
Note that both configurations may be used in a single source package.
+Change Log Format
+=================
+
+Changes made to the source package should be explained in the file `changelog`.
+
+Each new package revision must be documented with an entry of the following format:
+
+ package (version)
+ [zero or more blank lines]
+ * change details
+ [zero or more blank lines]
+ * more change details
+ more detailed change details
+ [zero or more blank lines]
+ -- maintainer date
+
+`package` is the source package name.
+
+`version` is the source package version number.
+
+`maintainer` is the name and e-mail address of the package maintainer. This
+field must follow the syntax of the `mailbox` symbol of RFC 5322 section 3.4.
+
+`date` is the date of packaging. This field must follow the syntax of the
+`date-time` symbol of RFC 5322 section 3.3.
+
+It is recommended that single blank lines be used:
+
+ * After the package name and version and before change entries,
+ * After change entries and before the maintainer and date, and
+ * Between groups of related change entries.
+
+
+Configuration File List Format
+==============================
+
+Platform-specific configuration files used by the source package at build time
+or by the binary package(s) at run time should be listed in the file `config`.
+
+Each file must be described with an entry of the following format:
+
+ type source destination
+
+`type` is the string `buildtime` for a file used at build time or `runtime` for
+a file used at run time.
+
+`source` is the path to the file, relative to the platform configuration
+directory -- either `/usr/share/config/PLATFORM/PACKAGE-VERSION` or
+`/usr/share/config/PLATFORM/PACKAGE`, where `PLATFORM` is the architcture string
+denoting an application platform, `PACKAGE` is the name of the configurable
+source package, and `VERSION` is the upstream version of the configurable source
+package.
+
+`destination` is the path (file or directory) to which the file should be
+copied. For a file used at build time, it is a path relative to the package
+building work area. For a file used at run time, it is an absolute path in the
+user's filesystem hierarchy.
+
+
Control File Format
===================
See documentation on Debian packaging.
+Source Package Metadata
+=======================
+
+The fields in the source package metadata are:
+
+ * `Source` (required)
+ The name of the source package. Source package names may only consist of
+ lowercase Latin letters, digits, plus and minus signs, and periods. Names
+ must be at least two characters long and must start with either a letter or
+ a digit.
+
+ * `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 Metadata
=======================
@@ -214,90 +298,6 @@ The fields in the binary package metadata are:
description.
-Source Package Metadata
-=======================
-
-The fields in the source package metadata are:
-
- * `Source` (required)
- The name of the source package. Source package names may only consist of
- lowercase Latin letters, digits, plus and minus signs, and periods. Names
- must be at least two characters long and must start with either a letter or
- a digit.
-
- * `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.
-
-
-Configuration File List Format
-==============================
-
-Platform-specific configuration files used by the source package at build time
-or by the binary package(s) at run time should be listed in the file `config`.
-
-Each file must be described with an entry of the following format:
-
- type source destination
-
-`type` is the string `buildtime` for a file used at build time or `runtime` for
-a file used at run time.
-
-`source` is the path to the file, relative to the platform configuration
-directory -- either `/usr/share/config/PLATFORM/PACKAGE-VERSION` or
-`/usr/share/config/PLATFORM/PACKAGE`, where `PLATFORM` is the architcture string
-denoting an application platform, `PACKAGE` is the name of the configurable
-source package, and `VERSION` is the upstream version of the configurable source
-package.
-
-`destination` is the path (file or directory) to which the file should be
-copied. For a file used at build time, it is a path relative to the package
-building work area. For a file used at run time, it is an absolute path in the
-user's filesystem hierarchy.
-
-
-Change Log Format
-=================
-
-Changes made to the source package should be explained in the file `changelog`.
-
-Each new package revision must be documented with an entry of the following format:
-
- package (version)
- [zero or more blank lines]
- * change details
- [zero or more blank lines]
- * more change details
- more detailed change details
- [zero or more blank lines]
- -- maintainer date
-
-`package` is the source package name.
-
-`version` is the source package version number.
-
-`maintainer` is the name and e-mail address of the package maintainer. This
-field must follow the syntax of the `mailbox` symbol of RFC 5322 section 3.4.
-
-`date` is the date of packaging. This field must follow the syntax of the
-`date-time` symbol of RFC 5322 section 3.3.
-
-It is recommended that single blank lines be used:
-
- * After the package name and version and before change entries,
- * After change entries and before the maintainer and date, and
- * Between groups of related change entries.
-
-
Legal Notice
============