diff options
Diffstat (limited to 'specs')
| -rw-r--r-- | specs/source-package-format-1.0.txt | 40 |
1 files changed, 25 insertions, 15 deletions
diff --git a/specs/source-package-format-1.0.txt b/specs/source-package-format-1.0.txt index cc33abc..ff510b9 100644 --- a/specs/source-package-format-1.0.txt +++ b/specs/source-package-format-1.0.txt @@ -22,6 +22,7 @@ to change. Comments and revisions are welcome. TODO ---- + * Finish describing binary package control fields. * Describe the control file format. @@ -133,43 +134,48 @@ Binary Package Metadata ======================= The fields in the binary package metadata are: - * Package (required) + + * Package (required) The name of the binary package. Binary 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. - * Architecture (required) + * Architecture (required) The names of the architectures for which this package is built. The list of names may consist of values selected from the following: + - A three-tuple binary architecture name to specify that the package can be built for the binary architecture and any application platform. - An application platform architecture name to specify that the package can be built for the application platform and its associated binary architecture. + Alternatively, the list may consist solely of one of the following values: + - The string "all" to specify that the package can be built on any binary architecture and any application platform and can then be installed on binary architectures and/or application platforms other than those on which it is built. - The string "any" to specify that the package cen be built for any binary architecture and any application platform. - * Essential (optional) + + * 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) + * 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) + * 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) + * 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. @@ -179,17 +185,18 @@ Source Package Metadata ======================= The fields in the source package metadata are: - * Source (required) + + * 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) + * 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) + * Build-Depends (optional) A list of packages that must be installed before the package can be built. - * Homepage + * Homepage 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 @@ -203,6 +210,7 @@ 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 @@ -227,6 +235,7 @@ 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 @@ -247,6 +256,7 @@ field must follow the syntax of the "mailbox" symbol of RFC 5322 section 3.4. "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. |