diff options
| -rw-r--r-- | specs/source-package-format-1.0.txt | 60 |
1 files changed, 30 insertions, 30 deletions
diff --git a/specs/source-package-format-1.0.txt b/specs/source-package-format-1.0.txt index 2e15eea..f816d3a 100644 --- a/specs/source-package-format-1.0.txt +++ b/specs/source-package-format-1.0.txt @@ -3,35 +3,35 @@ Date: 2012-02-26 -Status of This Document -======================= +1. Status of This Document +=========================== This specification is in `DRAFT` status. It is a work-in-progress and is subject to change. Comments and revisions are welcome. -Remaining Tasks ---------------- +1.1. Remaining Tasks +--------------------- * Finish describing binary package control fields. * Describe the control file format. -Abstract -======== +2. Abstract +============ This document describes version 1.0 of the format for software source packages. -Background -========== +3. Background +============== A source package consists of software source code, a build system, and package metadata. From it is built one or more binary packages, which can be installed into an operating system. -Rationale -========= +4. Rationale +============= This source package format is functionally similar to Debian's source package formats. It differs from them most noticeably in that: @@ -55,8 +55,8 @@ It may not be the most efficient or maintainer-friendly format, but this is an innovative first step and may be improved over time. -Directory Structure -=================== +5. Directory Structure +======================= The source package directory hierarchy can be summarized with the following tree: @@ -110,16 +110,16 @@ following: * `Z` for the "compress" algorithm. -Build File Format -================= +6. Build File Format +===================== 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). -Build Stamps ------------- +6.1. 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 @@ -131,8 +131,8 @@ done in build stamp targets. After successfully building one or more binary packages, a build stamp target should create its build stamp file in the work area directory. -Multiple and Split Binary Packages ----------------------------------- +6.2. Multiple and Split Binary Packages +---------------------------------------- Some source packages generate multiple binary packages from a single build of the packaged software. In the build makefiles of such source packages, the @@ -148,8 +148,8 @@ multiple binary package configuration. Note that both configurations may be used in a single source package. -Change Log Format -================= +7. Change Log Format +===================== Changes made to the source package should be explained in the file `changelog`. @@ -181,8 +181,8 @@ It is recommended that single blank lines be used: * Between groups of related change entries. -Configuration File List Format -============================== +8. 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`. @@ -207,14 +207,14 @@ building work area. For a file used at run time, it is an absolute path in the user's filesystem hierarchy. -Control File Format -=================== +9. Control File Format +======================= See documentation on Debian packaging. -Source Package Metadata -======================= +10. Source Package Metadata +============================ The fields in the source package metadata are: @@ -238,8 +238,8 @@ The fields in the source package metadata are: by angle brackets or any other characters. -Binary Package Metadata -======================= +11. Binary Package Metadata +============================ The fields in the binary package metadata are: @@ -298,8 +298,8 @@ The fields in the binary package metadata are: description. -Legal Notice -============ +12. Legal Notice +================= Copyright (C) 2012 Patrick "P. J." McDermott |