From 1494c07c2c0bcbffe27f09a49305230eaea83821 Mon Sep 17 00:00:00 2001 From: P. J. McDermott Date: Sun, 26 Feb 2012 00:18:47 -0500 Subject: Use Markdown code span formatting in spec. --- diff --git a/specs/source-package-format-1.0.txt b/specs/source-package-format-1.0.txt index 1f45c23..f5f7a2f 100644 --- a/specs/source-package-format-1.0.txt +++ b/specs/source-package-format-1.0.txt @@ -95,7 +95,7 @@ following: Build File Format ================= -An executable file named 'build' should direct the process of building one or +An executable file named `build` should direct the process of building one or more binary packages from a source package. This file should be a makefile with a target for each binary package (whose name is that of the binary package) and a target for each build stamp (whose name is that of the build stamp file). @@ -105,7 +105,7 @@ Build Stamps A build stamp is a file the existence of which indicates that one or more packages were successfully built. It is located in the package building work -area directory, and its name ends in ".buildstamp". +area directory, and its name ends in `.buildstamp`. In a makefile that directs the building of binary packages, each package target should depend on one build stamp target. Actual building of packages should be @@ -141,13 +141,13 @@ 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: @@ -159,37 +159,38 @@ The fields in the binary package metadata are: 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 + - 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 + - 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 + 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) + * `Recommends` (optional) - * Pre-Depends (optional) + * `Suggests` (optional) + + * `Pre-Depends` (optional) A list of packages that must be installed before the package may itself be installed. - * Conflicts (optional) + * `Conflicts` (optional) - * Provides (optional) + * `Provides` (optional) - * Replaces (optional) + * `Replaces` (optional) - * Description (required) + * `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. @@ -200,20 +201,20 @@ 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. + 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 @@ -224,23 +225,23 @@ 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'. +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 +`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 +`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 +`/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 +`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. @@ -249,7 +250,7 @@ user's filesystem hierarchy. Change Log Format ================= -Changes made to the source package should be explained in the file 'changelog'. +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: @@ -262,15 +263,15 @@ Each new package revision must be documented with an entry of the following form [zero or more blank lines] -- maintainer date -"package" is the source package name. +`package` is the source package name. -"version" is the source package version number. +`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. +`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. +`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: -- cgit v0.9.1