X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=policy.sgml;h=b27c9da5d95f5bd10a033705f1558344e347d994;hb=907905af29883401668ca56652c6b9e0a75f75fe;hp=a53af996df91466c027bc19e980f5d62a22f0eb9;hpb=5fa33a9bf643e15e62f42021aef121e062f437c3;p=debian%2Fdebian-policy.git diff --git a/policy.sgml b/policy.sgml index a53af99..b27c9da 100644 --- a/policy.sgml +++ b/policy.sgml @@ -24,6 +24,13 @@ Copyright © 1996,1997,1998 Ian Jackson and Christian Schwarz. +

+ These are the copyright dates of the original Policy manual. + Since then, this manual has been updated by many others. No + comprehensive collection of copyright notices for subsequent + work exists. +

+

This manual is free software; you may redistribute it and/or modify it under the terms of the GNU General Public License @@ -273,6 +280,32 @@

+ + Definitions + +

+ The following terms are used in this Policy Manual: + + ASCII + + The character encoding specified by ANSI X3.4-1986 and its + predecessor standards, referred to in MIME as US-ASCII, and + corresponding to an encoding in eight bits per character of + the first 128 characters, with the eighth bit always zero. + + UTF-8 + + The transformation format (sometimes called encoding) of + defined by + . UTF-8 has the useful property of having + ASCII as a subset, so any text encoded in ASCII is trivially + also valid UTF-8. + + +

+
@@ -292,8 +325,12 @@ system, but not every package we want to make accessible is free in our sense (see the Debian Free Software Guidelines, below), or may be imported/exported without - restrictions. Thus, the archive is split into the distribution - areas or categories based on their licenses and other restrictions. + restrictions. Thus, the archive is split into areas + The Debian archive software uses the term "component" internally + and in the Release file format to refer to the division of an + archive. The Debian Social Contract simply refers to "areas." + This document uses terminology similar to the Social Contract. + based on their licenses and other restrictions.

@@ -310,12 +347,12 @@

- The main category forms the - Debian GNU/Linux distribution. + The main archive area forms the Debian GNU/Linux + distribution.

- Packages in the other distribution areas (contrib, + Packages in the other archive areas (contrib, non-free) are not considered to be part of the Debian distribution, although we support their use and provide infrastructure for them (such as our bug-tracking system and @@ -422,10 +459,10 @@ - Categories + Archive areas - The main category + The main archive area

Every package in main must comply with the DFSG @@ -456,7 +493,7 @@ - The contrib category + The contrib archive area

Every package in contrib must comply with the DFSG. @@ -496,7 +533,7 @@ - The non-free category + The non-free archive area

Packages must be placed in non-free if they are @@ -612,27 +649,27 @@ Sections

- The packages in the categories main, - contrib and non-free are grouped further - into sections to simplify handling. + The packages in the archive areas main, + contrib and non-free are grouped further into + sections to simplify handling.

- The category and section for each package should be - specified in the package's Section control record - (see ). However, the maintainer of the - Debian archive may override this selection to ensure the - consistency of the Debian distribution. The - Section field should be of the form: + The archive area and section for each package should be + specified in the package's Section control record (see + ). However, the maintainer of the Debian + archive may override this selection to ensure the consistency of + the Debian distribution. The Section field should be + of the form: section if the package is in the - main category, + main archive area, - segment/section if the package is in + area/section if the package is in the contrib or non-free - distribution areas. + archive areas.

@@ -640,18 +677,20 @@

The Debian archive maintainers provide the authoritative list of sections. At present, they are: - admin, base, comm, - contrib, devel, doc, - editors, electronics, embedded, - games, gnome, graphics, - hamradio, interpreters, kde, - libs, libdevel, mail, - math, misc, net, news, - non-free, oldlibs, - otherosfs, perl, python, - science, shells, - sound, tex, text, - utils, web, x11. + admin, cli-mono, comm, database, + devel, debug, doc, editors, + electronics, embedded, fonts, + games, gnome, graphics, gnu-r, + gnustep, hamradio, haskell, + httpd, interpreters, java, kde, + kernel, libs, libdevel, lisp, + localization, mail, math, misc, + net, news, ocaml, oldlibs, + otherosfs, perl, php, python, + ruby, science, shells, sound, + tex, text, utils, vcs, + video, web, x11, xfce, + zope.

@@ -727,7 +766,8 @@ with required, important, standard or optional priorities, or are only likely to be useful if you already know what they are or have specialized - requirements. + requirements (such as packages containing only detached + debugging symbols).

@@ -985,29 +1025,23 @@ (see below), and should not do so unless they depend on a particular version of that package.

- Essential is defined as the minimal set of functionality - that must be available and usable on the system even - when packages are in an unconfigured (but unpacked) - state. This is needed to avoid unresolvable dependency - loops on upgrade. If packages add unnecessary - dependencies on packages in this set, the chances that - there will be an unresolvable - dependency loop caused by forcing these Essential - packages to be configured first before they need to be - is greatly increased. It also increases the chances - that frontends will be unable to - calculate an upgrade path, even if one - exists. + Essential is needed in part to avoid unresolvable dependency + loops on upgrade. If packages add unnecessary dependencies + on packages in this set, the chances that there + will be an unresolvable dependency loop + caused by forcing these Essential packages to be configured + first before they need to be is greatly increased. It also + increases the chances that frontends will be unable to + calculate an upgrade path, even if one + exists.

- Also, it's pretty unlikely that functionality from - Essential shall ever be removed (which is one reason why - care must be taken before adding to the Essential - packages set), but packages have been removed - from the Essential set when the functionality moved to a - different package. So depending on these packages - just in case they stop being essential does way - more harm than good. + Also, functionality is rarely ever removed from the + Essential set, but packages have been removed from + the Essential set when the functionality moved to a + different package. So depending on these packages just + in case they stop being essential does way more harm + than good.

@@ -1078,15 +1112,15 @@

The base system is a minimum subset of the Debian GNU/Linux system that is installed before everything else - on a new system. Thus, only very few packages are allowed - to go into the base section to keep the required - disk usage very small. + on a new system. Only very few packages are allowed to form + part of the base system, in order to keep the required disk + usage very small.

- Most of these packages will have the priority value - required or at least important, and many - of them will be tagged essential (see below). + The base system consists of all those packages with priority + required or important. Many of them will + be tagged essential (see below).

@@ -1094,10 +1128,13 @@ Essential packages

- Some packages are tagged essential for a system - using the Essential control file field. - The format of the Essential control field is - described in . + Essential is defined as the minimal set of functionality that + must be available and usable on the system at all times, even + when packages are in an unconfigured (but unpacked) state. + Packages are tagged essential for a system using the + Essential control file field. The format of the + Essential control field is described in .

@@ -1121,6 +1158,19 @@ appropriate.

+

+ Maintainers should take great care in adding any programs, + interfaces, or functionality to essential packages. + Packages may assume that functionality provided by + essential packages is always available without + declaring explicit dependencies, which means that removing + functionality from the Essential set is very difficult and is + almost never done. Any capability added to an + essential package therefore creates an obligation to + support that capability as part of the Essential set in + perpetuity. +

+

You must not tag any packages essential before this has been discussed on the debian-devel @@ -1177,21 +1227,20 @@ Prompting in maintainer scripts

Package maintainer scripts may prompt the user if - necessary. Prompting should be done by communicating + necessary. Prompting must be done by communicating through a program, such as debconf, which - conforms to the Debian Configuration management - specification, version 2 or higher. Prompting the user by - other means, such as by hand - From the Jargon file: by hand 2. By extension, - writing code which does something in an explicit or - low-level way for which a presupplied library - (debconf, in this instance) routine ought - to have been available. - , is now deprecated. + conforms to the Debian Configuration Management + Specification, version 2 or higher.

- The Debian Configuration management specification is included + Packages which are essential, or which are dependencies of + essential packages, may fall back on another prompting method + if no such interface is available when they are executed. +

+ +

+ The Debian Configuration Management Specification is included in the debconf_specification files in the debian-policy package. It is also available from the Debian web mirrors at @@ -1200,8 +1249,8 @@

- Packages which use the Debian Configuration management - specification may contain an additional + Packages which use the Debian Configuration Management + Specification may contain an additional config script and a templates file in their control archive The control.tar.gz inside the .deb. @@ -1213,18 +1262,18 @@ Therefore it must work using only the tools present in essential packages. Debconf or another tool that - implements the Debian Configuration management - specification will also be installed, and any + implements the Debian Configuration Management + Specification will also be installed, and any versioned dependencies on it will be satisfied before preconfiguration begins.

- Packages which use the Debian Configuration management - specification must allow for translation of their messages - by using a gettext-based system such as the one provided by - the po-debconf package. + Packages which use the Debian Configuration Management + Specification must allow for translation of their user-visible + messages by using a gettext-based system such as the one + provided by the po-debconf package.

@@ -1472,10 +1521,6 @@

-

- -

-

The format of the debian/changelog allows the package building tools to discover which version of the package @@ -1547,8 +1592,8 @@ /closes:\s*(?:bug)?\#?\s?\d+(?:,\s*(?:bug)?\#?\s?\d+)*/i Then all of the bug numbers listed will be closed by the - archive maintenance script (katie), or in - the case of an NMU, marked as fixed. + archive maintenance script (katie) using the + version of the changelog entry. This information is conveyed via the Closes field in the .changes file (see ). @@ -1566,52 +1611,31 @@

- The date should be in RFC822 format + The date must be in RFC822 format This is generated by date -R. - ; it should include the time zone specified + ; it must include the time zone specified numerically, with the time zone name or abbreviation optionally present as a comment in parentheses.

- The first "title" line with the package name should start - at the left hand margin; the "trailer" line with the - maintainer and date details should be preceded by exactly + The first "title" line with the package name must start + at the left hand margin. The "trailer" line with the + maintainer and date details must be preceded by exactly one space. The maintainer details and the date must be separated by exactly two spaces.

+

+ The entire changelog must be encoded in UTF-8. +

+

For more information on placement of the changelog files within binary packages, please see .

- - Alternative changelog formats - -

- In non-experimental packages you must use a format for - debian/changelog which is supported by the most - recent released version of dpkg. -

- -

- It is possible to use a format different from the standard - one by providing a changelog parser for the format you wish - to use. The parser must have an API compatible with that - expected by dpkg-genchanges and - dpkg-gencontrol, and it must not interact with - the user at all. - - If there is general interest in the new format, you should - contact the dpkg maintainer to have the - parser script for it included in the dpkg - package. (You will need to agree that the parser and its - man page may be distributed under the GNU GPL, just as the rest - of dpkg is.) - -

-
+ Copyright: debian/copyright

@@ -1926,6 +1950,19 @@ possible is a good idea.

+ + patch (optional) + +

+ This target performs whatever additional actions are + required to make the source ready for editing (unpacking + additional upstream archives, applying patches, etc.). + It is recommended to be implemented for any package where + dpkg-source -x does not result in source ready + for additional modification. See + . +

+

@@ -1955,6 +1992,12 @@ DEB_*_ARCH (the Debian architecture) + + DEB_*_ARCH_CPU (the Debian CPU name) + + + DEB_*_ARCH_OS (the Debian System name) + DEB_*_GNU_TYPE (the GNU style architecture specification string) @@ -1983,9 +2026,121 @@ It is important to understand that the DEB_*_ARCH string only determines which Debian architecture we are building on or for. It should not be used to get the CPU - or system information; the GNU style variables should be - used for that. -

+ or system information; the DEB_*_ARCH_CPU and + DEB_*_ARCH_OS variables should be used for that. + GNU style variables should generally only be used with upstream + build systems. +

+ + + debian/rules and + DEB_BUILD_OPTIONS + +

+ Supporting the standardized environment variable + DEB_BUILD_OPTIONS is recommended. This variable can + contain several flags to change how a package is compiled and + built. Each flag must be in the form flag or + flag=options. If multiple flags are + given, they must be separated by whitespace. + Some packages support any delimiter, but whitespace is the + easiest to parse inside a makefile and avoids ambiguity with + flag values that contain commas. + + flag must start with a lowercase letter + (a-z) and consist only of lowercase letters, + numbers (0-9), and the characters + - and _ (hyphen and underscore). + options must not contain whitespace. The same + tag should not be given multiple times with conflicting + values. Package maintainers may assume that + DEB_BUILD_OPTIONS will not contain conflicting tags. +

+ +

+ The meaning of the following tags has been standardized: + + nocheck + + This tag says to not run any build-time test suite + provided by the package. + + noopt + + The presence of this tag means that the package should + be compiled with a minimum of optimization. For C + programs, it is best to add -O0 to + CFLAGS (although this is usually the default). + Some programs might fail to build or run at this level + of optimization; it may be necessary to use + -O1, for example. + + nostrip + + This tag means that the debugging symbols should not be + stripped from the binary during installation, so that + debugging information may be included in the package. + + parallel=n + + This tag means that the package should be built using up + to n parallel processes if the package build + system supports this. + Packages built with make can often implement + this by passing the -jn option to + make. + + If the package build system does not support parallel + builds, this string must be ignored. If the package + build system only supports a lower level of concurrency + than n, the package should be built using as + many parallel processes as the package build system + supports. It is up to the package maintainer to decide + whether the package build times are long enough and the + package build system is robust enough to make supporting + parallel builds worthwhile. + + +

+ +

+ Unknown flags must be ignored by debian/rules. +

+ +

+ The following makefile snippet is an example of how one may + implement the build options; you will probably have to + massage this example in order to make it work for your + package. + +CFLAGS = -Wall -g +INSTALL = install +INSTALL_FILE = $(INSTALL) -p -o root -g root -m 644 +INSTALL_PROGRAM = $(INSTALL) -p -o root -g root -m 755 +INSTALL_SCRIPT = $(INSTALL) -p -o root -g root -m 755 +INSTALL_DIR = $(INSTALL) -p -d -o root -g root -m 755 + +ifneq (,$(filter noopt,$(DEB_BUILD_OPTIONS))) + CFLAGS += -O0 +else + CFLAGS += -O2 +endif +ifeq (,$(filter nostrip,$(DEB_BUILD_OPTIONS))) + INSTALL_PROGRAM += -s +endif +ifneq (,$(filter parallel=%,$(DEB_BUILD_OPTIONS))) + NUMJOBS = $(patsubst parallel=%,%,$(filter parallel=%,$(DEB_BUILD_OPTIONS))) + MAKEFLAGS += -j$(NUMJOBS) +endif + +build: + # ... +ifeq (,$(filter nocheck,$(DEB_BUILD_OPTIONS))) + # Code to run the package test suite. +endif + +

+
@@ -2012,7 +2167,7 @@

- See for full + See for full details about source variable substitutions, including the format of debian/substvars.

@@ -2104,6 +2259,57 @@

+ + Source package handling: + debian/README.source + +

+ If running dpkg-source -x on a source package + doesn't produce the source of the package, ready for editing, + and allow one to make changes and run + dpkg-buildpackage to produce a modified package + without taking any additional steps, creating a + debian/README.source documentation file is + recommended. This file should explain how to do all of the + following: + + Generate the fully patched source, in a form ready for + editing, that would be built to create Debian + packages. Doing this with a patch target in + debian/rules is recommended; see + . + Modify the source and save those modifications so that + they will be applied when building the package. + Remove source modifications that are currently being + applied when building the package. + Optionally, document what steps are necessary to + upgrade the Debian source package to a new upstream version, + if applicable. + + This explanation should include specific commands and mention + any additional required Debian packages. It should not assume + familiarity with any specific Debian packaging system or patch + management tools. +

+ +

+ This explanation may refer to a documentation file installed by + one of the package's build dependencies provided that the + referenced documentation clearly explains these tasks and is not + a general reference manual. +

+ +

+ debian/README.source may also include any other + information that would be helpful to someone modifying the + source package. Even if the package doesn't fit the above + description, maintainers are encouraged to document in a + debian/README.source file any source package with a + particularly complex or unintuitive source layout or build + system (for example, a package that builds the same source + multiple times to generate different binary packages). +

+
@@ -2181,6 +2387,9 @@ Package: libc6 would mean a new paragraph.

+

+ All control files must be encoded in UTF-8. +

@@ -2210,6 +2419,7 @@ Package: libc6 Priority (recommended) Build-Depends et al Standards-Version (recommended) + Homepage

@@ -2224,6 +2434,7 @@ Package: libc6 Essential Depends et al Description (mandatory) + Homepage

@@ -2255,6 +2466,15 @@ Package: libc6 See for details.

+

+ In addition to the control file syntax described above, this file may also contain + comment lines starting with # without any preceding + whitespace. All such lines are ignored, even in the middle of + continuation lines for a multiline field, and do not end a + multiline field. +

+
@@ -2280,6 +2500,7 @@ Package: libc6 Installed-Size Maintainer (mandatory) Description (mandatory) + Homepage

@@ -2304,6 +2525,7 @@ Package: libc6 Build-Depends et al Standards-Version (recommended) Files (mandatory) + Homepage

@@ -2381,6 +2603,14 @@ Package: libc6 package control file when the source package has the same name and version as the binary package.

+ +

+ Package names must consist only of lower case letters + (a-z), digits (0-9), plus (+) + and minus (-) signs, and periods (.). + They must be at least two characters long and must start + with an alphanumeric character. +

@@ -2495,7 +2725,7 @@ Package: libc6 values: A unique single word identifying a Debian machine - architecture, see . + architecture as described in . all, which indicates an architecture-independent package. any, which indicates a package available @@ -2506,31 +2736,53 @@ Package: libc6

In the main debian/control file in the source - package, or in the source package control file - .dsc, one may specify a list of architectures - separated by spaces, or the special values any or - all. + package, this field may contain the special value + any, the special value all, or a list of + architectures separated by spaces. If any or + all appear, they must be the entire contents of the + field. Most packages will use either any or + all. Specifying a specific list of architectures is + for the minority of cases where a program is not portable or + is not useful on some architectures, and where possible the + program should be made portable instead. +

+ +

+ In the source package control file .dsc, this + field may contain either the special value any or a + list of architectures separated by spaces. If a list is given, + it may include (or consist solely of) the special value + all. In other words, in .dsc files + unlike the debian/control, all may occur + in combination with specific architectures. The + Architecture field in the source package control file + .dsc is generally constructed from the + Architecture fields in the + debian/control in the source package.

Specifying any indicates that the source package isn't dependent on any particular architecture and should compile fine on any one. The produced binary package(s) - will be specific to whatever the current build architecture - is. - This is the most often used setting, and is recommended - for new packages that aren't Architecture: all. - + will either be specific to whatever the current build + architecture is or will be architecture-independent. +

+ +

+ Specifying only all indicates that the source package + will only build architecture-independent packages. If this is + the case, all must be used rather than any; + any implies that the source package will build at + least one architecture-dependent package.

Specifying a list of architectures indicates that the source will build an architecture-dependent package, and will only - work correctly on the listed architectures. - This is a setting used for a minority of cases where the - program is not portable. Generally, it should not be used - for new packages. - + work correctly on the listed architectures. If the source + package also builds at least one architecture-independent + package, all will also be included in the list.

@@ -2538,7 +2790,11 @@ Package: libc6 field lists the architecture(s) of the package(s) currently being uploaded. This will be a list; if the source for the package is also being uploaded, the special - entry source is also present. + entry source is also present. all will be + present if any architecture-independent packages are being + uploaded. any may never occur in the + Architecture field in the .changes + file.

@@ -2567,7 +2823,8 @@ Package: libc6 Package interrelationship fields: Depends, Pre-Depends, - Recommends, Suggests, Conflicts, + Recommends, Suggests, + Breaks, Conflicts, Provides, Replaces, Enhances @@ -2709,19 +2966,22 @@ Package: libc6 number apart at the last hyphen in the string (if there is one) to determine the upstream_version and debian_revision. The absence of a - debian_revision compares earlier than the - presence of one (but note that the - debian_revision is the least significant part - of the version number). + debian_revision is equivalent to a + debian_revision of 0.

- The upstream_version and debian_revision + When comparing two version numbers, first the epoch + of each are compared, then the upstream_version if + epoch is equal, and then debian_revision + if upstream_version is also equal. + epoch is compared numerically. The + upstream_version and debian_revision parts are compared by the package management system using the - same algorithm: + following algorithm:

@@ -2865,76 +3125,39 @@ Package: libc6 distribution(s) where this version of the package should be installed. Valid distributions are determined by the archive maintainers. - Current distribution names are: + Example distribution names in the Debian archive used in + .changes files are: - stable - - This is the current "released" version of Debian - GNU/Linux. Once the distribution is - stable only security fixes and other - major bug fixes are allowed. When changes are - made to this distribution, the release number is - increased (for example: 2.2r1 becomes 2.2r2 then - 2.2r3, etc). - - unstable - This distribution value refers to the - developmental part of the Debian - distribution tree. New packages, new upstream - versions of packages and bug fixes go into the - unstable directory tree. Download from - this distribution at your own risk. - - - testing - - This distribution value refers to the - testing part of the Debian distribution - tree. It receives its packages from the - unstable distribution after a short time lag to - ensure that there are no major issues with the - unstable packages. It is less prone to breakage - than unstable, but still risky. It is not - possible to upload packages directly to - testing. - - - frozen - - From time to time, the testing - distribution enters a state of "code-freeze" in - anticipation of release as a stable - version. During this period of testing only - fixes for existing or newly-discovered bugs will - be allowed. The exact details of this stage are - determined by the Release Manager. + This distribution value refers to the + developmental part of the Debian distribution + tree. Most new packages, new upstream versions of + packages and bug fixes go into the unstable + directory tree. experimental - The packages with this distribution value are - deemed by their maintainers to be high - risk. Oftentimes they represent early beta or - developmental packages from various sources that - the maintainers want people to try, but are not - ready to be a part of the other parts of the - Debian distribution tree. Download at your own - risk. + The packages with this distribution value are deemed + by their maintainers to be high risk. Oftentimes they + represent early beta or developmental packages from + various sources that the maintainers want people to + try, but are not ready to be a part of the other parts + of the Debian distribution tree.

- You should list all distributions that the - package should be installed into. -

- -

- More information is available in the Debian Developer's - Reference, section "The Debian archive". + Others are used for updating stable releases or for + security uploads. More information is available in the + Debian Developer's Reference, section "The Debian + archive".

+ The Debian archive software only supports listing a single + distribution. Migration of packages to other distributions is + handled outside of the upload process.

@@ -3075,8 +3298,9 @@ Package: libc6

- The disk space is represented in kilobytes as a simple - decimal number. + The disk space is given as the integer value of the installed + size divided by 1024 (in other words, the size in kibibytes) + and rounded up.

@@ -3147,6 +3371,19 @@ Package: libc6

+ + Homepage + +

+ The URL of the web site for this package, preferably (when + applicable) the site from which the original source can be + obtained and any additional upstream documentation or + information may be found. The content of this field is a + simple URL without any surrounding characters such as + <>. +

+
+ @@ -3226,8 +3463,7 @@ Package: libc6 scripts this means that you almost always need to use set -e (this is usually true when writing shell scripts, in fact). It is also important, of course, that - they don't exit with a non-zero status if everything went - well. + they exit with a zero status if everything went well.

@@ -3358,8 +3594,8 @@ Package: libc6 deconfigured's-postinst abort-deconfigure in-favour failed-install-package version - removing conflicting-package - version + [removing conflicting-package + version] @@ -3384,9 +3620,9 @@ Package: libc6 deconfigured's-prerm deconfigure in-favour package-being-installed - version removing + version [removing conflicting-package - version + version] @@ -3467,11 +3703,30 @@ Package: libc6 - If a "conflicting" package is being removed at the same time: + If a "conflicting" package is being removed at the same time, + or if any package will be broken (due to Breaks): - If any packages depended on that conflicting - package and --auto-deconfigure is + If --auto-deconfigure is + specified, call, for each package to be deconfigured + due to Breaks: + +deconfigured's-prerm deconfigure \ + in-favour package-being-installed version + + Error unwind: + +deconfigured's-postinst abort-deconfigure \ + in-favour package-being-installed-but-failed version + + The deconfigured packages are marked as + requiring configuration, so that if + --install is used they will be + configured again if possible. + + + If any packages depended on a conflicting + package being removed and --auto-deconfigure is specified, call, for each such package: deconfigured's-prerm deconfigure \ @@ -3490,7 +3745,7 @@ Package: libc6 configured again if possible. - To prepare for removal of the conflicting package, call: + To prepare for removal of each conflicting package, call: conflictor's-prerm remove \ in-favour package new-version @@ -3960,6 +4215,22 @@ Build-Depends-Indep: texinfo Build-Depends: kernel-headers-2.2.10 [!hurd-i386], hurd-dev [hurd-i386], gnumach-dev [hurd-i386] + requires kernel-headers-2.2.10 on all architectures + other than hurd-i386 and requires hurd-dev and + gnumach-dev only on hurd-i386. +

+ +

+ If the architecture-restricted dependency is part of a set of + alternatives using |, that alternative is ignored + completely on architectures that do not match the restriction. + For example: + +Build-Depends: foo [!i386] | bar [!amd64] + + is equivalent to bar on the i386 architecture, to + foo on the amd64 architecture, and to foo | + bar on all other architectures.

@@ -3987,16 +4258,22 @@ Build-Depends: kernel-headers-2.2.10 [!hurd-i386],

This is done using the Depends, Pre-Depends, - Recommends, Suggests, Enhances and - Conflicts control file fields. + Recommends, Suggests, Enhances, + Breaks and Conflicts control file fields. + Breaks is described in , and + Conflicts is described in . The + rest are described below.

- These six fields are used to declare a dependency + These seven fields are used to declare a dependency relationship by one package on another. Except for - Enhances, they appear in the depending (binary) - package's control file. (Enhances appears in the - recommending package's control file.) + Enhances and Breaks, they appear in the + depending (binary) package's control file. + (Enhances appears in the recommending package's + control file, and Breaks appears in the version of + depended-on package which causes the named package to + break).

@@ -4034,7 +4311,7 @@ Build-Depends: kernel-headers-2.2.10 [!hurd-i386], (based on rules below), and some packages may not be able to rely on their dependencies being present when being installed or removed, depending on which side of the break - of the circular dependcy loop they happen to be on. If one + of the circular dependency loop they happen to be on. If one of the packages in the loop has no postinst script, then the cycle will be broken at that package, so as to ensure that all postinst scripts run with the dependencies properly @@ -4170,6 +4447,47 @@ Build-Depends: kernel-headers-2.2.10 [!hurd-i386],

+ + Packages which break other packages - Breaks + +

+ When one binary package declares that it breaks another, + dpkg will refuse to allow the package which + declares Breaks be installed unless the broken + package is deconfigured first, and it will refuse to + allow the broken package to be reconfigured. +

+ +

+ A package will not be regarded as causing breakage merely + because its configuration files are still installed; it must + be at least half-installed. +

+ +

+ A special exception is made for packages which declare that + they break their own package name or a virtual package which + they provide (see below): this does not count as a real + breakage. +

+ +

+ Normally a Breaks entry will have an "earlier than" + version clause; such a Breaks is introduced in the + version of an (implicit or explicit) dependency which + violates an assumption or reveals a bug in earlier versions + of the broken package. This use of Breaks will + inform higher-level package management tools that broken + package must be upgraded before the new one. +

+ +

+ If the breaking package also overwrites some files from the + older package, it should use Replaces (not + Conflicts) to ensure this goes smoothly. +

+
+ Conflicting binary packages - Conflicts @@ -4215,7 +4533,8 @@ Build-Depends: kernel-headers-2.2.10 [!hurd-i386], "earlier than" version clause. This would prevent dpkg from upgrading or installing the package which declared such a conflict until the upgrade or removal - of the conflicted-with package had been completed. + of the conflicted-with package had been completed. Instead, + Breaks may be used.

@@ -4226,7 +4545,7 @@ Build-Depends: kernel-headers-2.2.10 [!hurd-i386], As well as the names of actual ("concrete") packages, the package relationship fields Depends, Recommends, Suggests, Enhances, - Pre-Depends, Conflicts, + Pre-Depends, Breaks, Conflicts, Build-Depends, Build-Depends-Indep, Build-Conflicts and Build-Conflicts-Indep may mention "virtual packages". @@ -4262,16 +4581,16 @@ Provides: bar

- If a dependency or a conflict has a version number attached + If a relationship field has a version number attached then only real packages will be considered to see whether the relationship is satisfied (or the prohibition violated, - for a conflict) - it is assumed that a real package which - provides the virtual package is not of the "right" version. - So, a Provides field may not contain version - numbers, and the version number of the concrete package - which provides a particular virtual package will not be - looked at when considering a dependency on or conflict with - the virtual package name. + for a conflict or breakage) - it is assumed that a real + package which provides the virtual package is not of the + "right" version. So, a Provides field may not + contain version numbers, and the version number of the + concrete package which provides a particular virtual package + will not be looked at when considering a dependency on or + conflict with the virtual package name.

@@ -4513,21 +4832,6 @@ Replaces: mail-transport-agent instead.

-

- If your package includes run-time support programs that - do not need to be invoked manually by users, but are - nevertheless required for the package to function, then it - is recommended that these programs are placed - (if they are binary) in a subdirectory of - /usr/lib, preferably under - /usr/lib/package-name. - If the program is architecture independent, the - recommendation is for it to be placed in a subdirectory of - /usr/share instead, preferably under - /usr/share/package-name. -

- -

If you have several shared libraries built from the same source tree you may lump them all together into a single @@ -4670,24 +4974,50 @@ Replaces: mail-transport-agent - - Run-time support programs + + Shared library support files -

- If your package has some run-time support programs which use - the shared library you must not put them in the shared - library package. If you do that then you won't be able to - install several versions of the shared library without - getting filename clashes. -

+

+ If your package contains files whose names do not change with + each change in the library shared object version, you must not + put them in the shared library package. Otherwise, several + versions of the shared library cannot be installed at the same + time without filename clashes, making upgrades and transitions + unnecessarily difficult. +

-

- Instead, either create another package for the runtime binaries - (this package might typically be named - libraryname-runtime; note the absence - of the soversion in the package name), or if the - development package is small, include them in there. -

+

+ It is recommended that supporting files and run-time support + programs that do not need to be invoked manually by users, but + are nevertheless required for the package to function, be placed + (if they are binary) in a subdirectory of /usr/lib, + preferably under /usr/lib/package-name. + If the program or file is architecture independent, the + recommendation is for it to be placed in a subdirectory of + /usr/share instead, preferably under + /usr/share/package-name. Following the + package-name naming convention ensures that the file + names change when the shared object version changes. +

+ +

+ Run-time support programs that use the shared library but are + not required for the library to function or files used by the + shared library that can be used by any version of the shared + library package should instead be put in a separate package. + This package might typically be named + libraryname-tools; note the + absence of the soversion in the package name. +

+ +

+ Files and support programs only useful when compiling software + against the library should be included in the development + package for the library. + For example, a package-name-config + script or pkg-config configuration files. + +

@@ -5205,23 +5535,16 @@ libbar 1 bar1 (>= 1.0-1) - File system Structure + File System Structure

The location of all installed files and directories must - comply with the File system Hierarchy Standard (FHS), + comply with the Filesystem Hierarchy Standard (FHS), version 2.3, with the exceptions noted below, and except where doing so would violate other terms of Debian Policy. The following exceptions to the FHS apply: - -

- Legacy XFree86 servers are permitted to retain the - configuration file location - /etc/X11/XF86Config-4. -

-

The optional rules related to user specific @@ -5371,7 +5694,7 @@ rmdir /usr/local/share/emacs 2>/dev/null || true The /usr/local directory itself and all the subdirectories created by the package should (by default) have permissions 2775 (group-writable and set-group-id) and be - owned by root.staff. + owned by root:staff.

@@ -5383,12 +5706,6 @@ rmdir /usr/local/share/emacs 2>/dev/null || true by any particular mail agents. The use of the old location /var/spool/mail is deprecated, even though the spool may still be physically located there. - To maintain partial upgrade compatibility for systems - which have /var/spool/mail as their physical mail - spool, packages using /var/mail must depend on - either libc6 (>= 2.1.3-13), or on - base-files (>= 2.2.0), or on later - versions of either one of these packages.

@@ -5628,13 +5945,6 @@ rmdir /usr/local/share/emacs 2>/dev/null || true K prefix, but they too are called with the single argument stop.

- -

- Also, if the script name ends in .sh, the script - will be sourced in runlevel S rather than being - run in a forked subprocess, but will be explicitly run by - sh in all other runlevels. -

@@ -5678,11 +5988,13 @@ rmdir /usr/local/share/emacs 2>/dev/null || true

The init.d scripts must ensure that they will - behave sensibly if invoked with start when the - service is already running, or with stop when it - isn't, and that they don't kill unfortunately-named user - processes. The best way to achieve this is usually to use - start-stop-daemon. + behave sensibly (i.e., returning success and not starting + multiple copies of a service) if invoked with start + when the service is already running, or with stop + when it isn't, and that they don't kill unfortunately-named + user processes. The best way to achieve this is usually to + use start-stop-daemon with the --oknodo + option.

@@ -5756,6 +6068,18 @@ test -f program-executed-later-in-script || exit 0 script must behave sensibly and not fail if the /etc/default file is deleted.

+ +

+ /var/run and /var/lock may be mounted + as temporary filesystems + For example, using the RAMRUN and RAMLOCK + options in /etc/default/rcS. + , so the init.d scripts must handle this + correctly. This will typically amount to creating any required + subdirectories dynamically when the init.d script + is run, rather than including them in the package and relying on + dpkg to create them. +

@@ -6136,12 +6460,13 @@ Reloading description configuration...done. via cron, it should place a file with the name of the package in one or more of the following directories: +/etc/cron.hourly /etc/cron.daily /etc/cron.weekly /etc/cron.monthly As these directory names imply, the files within them are - executed on a daily, weekly, or monthly basis, + executed on an hourly, daily, weekly, or monthly basis, respectively. The exact times are listed in /etc/crontab.

@@ -6149,13 +6474,12 @@ Reloading description configuration...done. All files installed in any of these directories must be scripts (e.g., shell scripts or Perl scripts) so that they can easily be modified by the local system administrator. - In addition, they should be treated as configuration - files. + In addition, they must be treated as configuration files.

- If a certain job has to be executed more frequently than - daily, the package should install a file + If a certain job has to be executed at some other frequency or + at a specific time, the package should install a file /etc/cron.d/package. This file uses the same syntax as /etc/crontab and is processed by cron automatically. The file must also be @@ -6508,58 +6832,12 @@ INSTALL = install -s # (or use strip on the files in debian/tmp)

Although binaries in the build tree should be compiled with - debugging information by default, it can often be difficult - to debug programs if they are also subjected to compiler - optimization. For this reason, it is recommended to support - the standardized environment - variable DEB_BUILD_OPTIONS. This variable can - contain several flags to change how a package is compiled - and built. -

- -

- - noopt - - The presence of this string means that the package - should be compiled with a minimum of optimization. - For C programs, it is best to add -O0 - to CFLAGS (although this is usually the - default). Some programs might fail to build or run at - this level of optimization; it may be necessary to - use -O1, for example. - - nostrip - - This string means that the debugging symbols should - not be stripped from the binary during installation, - so that debugging information may be included in the package. - - -

- -

- The following makefile snippet is an example of how one may - implement the build options; you will probably have to - massage this example in order to make it work for your - package. - -CFLAGS = -Wall -g -INSTALL = install -INSTALL_FILE = $(INSTALL) -p -o root -g root -m 644 -INSTALL_PROGRAM = $(INSTALL) -p -o root -g root -m 755 -INSTALL_SCRIPT = $(INSTALL) -p -o root -g root -m 755 -INSTALL_DIR = $(INSTALL) -p -d -o root -g root -m 755 - -ifneq (,$(findstring noopt,$(DEB_BUILD_OPTIONS))) -CFLAGS += -O0 -else -CFLAGS += -O2 -endif -ifeq (,$(findstring nostrip,$(DEB_BUILD_OPTIONS))) -INSTALL_PROGRAM += -s -endif - + debugging information by default, it can often be difficult to + debug programs if they are also subjected to compiler + optimization. For this reason, it is recommended to support the + standardized environment variable DEB_BUILD_OPTIONS + (see ). This variable can contain + several flags to change how a package is compiled and built.

@@ -6820,18 +7098,19 @@ strip --strip-unneeded your-lib support -a and -o as binary logical operators. local to create a scoped variable must be - supported; however, local may or may not preserve - the variable value from an outer scope and may or may not - support arguments more complex than simple variables. Only - uses such as: + supported, including listing multiple variables in a single + local command and assigning a value to a variable at the + same time as localizing it. local may or + may not preserve the variable value from an outer scope if + no assignment is present. Uses such as: fname () { - local a - a='' - # ... use a ... + local a b c=delta d + # ... use a, b, c, d ... } - must be supported. + must be supported and must set the value of c to + delta. If a shell script requires non-SUSv3 features from the shell @@ -7000,10 +7279,13 @@ ln -fs ../sbin/sendmail debian/tmp/usr/bin/runq

- Note that a script that embeds configuration information - (such as most of the files in /etc/default and - /etc/cron.{daily,weekly,monthly}) is de-facto a - configuration file and should be treated as such. + As noted elsewhere, /etc/init.d scripts, + /etc/default files, scripts installed in + /etc/cron.{hourly,daily,weekly,monthly}, and cron + configuration installed in /etc/cron.d must be + treated as configuration files. In general, any script that + embeds configuration information is de-facto a configuration + file and should be treated as such.

@@ -7320,7 +7602,7 @@ endscript

- Files should be owned by root.root, and made + Files should be owned by root:root, and made writable only by the owner and universally readable (and executable, if appropriate), that is mode 644 or 755.

@@ -7445,16 +7727,6 @@ endscript description of the use of dpkg-statoverride.

-

- dpkg-statoverride is a replacement for the - deprecated suidmanager package. Packages which - previously used suidmanager should have a - Conflicts: suidmanager (<< 0.50) entry (or even - (<< 0.52)), and calls to suidregister - and suidunregister should now be simply removed - from the maintainer scripts. -

-

If a system administrator wishes to have a file (or directory or other such thing) installed with owner and @@ -7831,16 +8103,31 @@ http://localhost/doc/package/filename

- Mailboxes are generally mode 660 - user.mail unless the system - administrator has chosen otherwise. A MUA may remove a - mailbox (unless it has nonstandard permissions) in which - case the MTA or another MUA must recreate it if needed. - Mailboxes must be writable by group mail. -

- -

- The mail spool is 2775 root.mail, and MUAs should + Mailboxes are generally either mode 600 and owned by + user or mode 660 and owned by + user:mail + There are two traditional permission schemes for mail spools: + mode 600 with all mail delivery done by processes running as + the destination user, or mode 660 and owned by group mail with + mail delivery done by a process running as a system user in + group mail. Historically, Debian required mode 660 mail + spools to enable the latter model, but that model has become + increasingly uncommon and the principle of least privilege + indicates that mail systems that use the first model should + use permissions of 600. If delivery to programs is permitted, + it's easier to keep the mail system secure if the delivery + agent runs as the destination user. Debian Policy therefore + permits either scheme. + . The local system administrator may choose a + different permission scheme; packages should not make + assumptions about the permission and ownership of mailboxes + unless required (such as when creating a new mailbox). A MUA + may remove a mailbox (unless it has nonstandard permissions) in + which case the MTA or another MUA must recreate it if needed. +

+ +

+ The mail spool is 2775 root:mail, and MUAs should be setgid mail to do the locking mentioned above (and must obviously avoid accessing other users' mailboxes using this privilege).

@@ -8135,11 +8422,6 @@ name ["syshostname"]: - - Speedo fonts must be placed in - /usr/share/fonts/X11/Speedo/. - - Type 1 fonts must be placed in /usr/share/fonts/X11/Type1/. If font @@ -8151,9 +8433,9 @@ name ["syshostname"]: Subdirectories of /usr/share/fonts/X11/ other than those listed above must be neither created nor used. (The PEX, CID, - and cyrillic directories are excepted for - historical reasons, but installation of files into - these directories remains discouraged.) + Speedo, and cyrillic directories + are excepted for historical reasons, but installation of + files into these directories remains discouraged.) @@ -8272,8 +8554,7 @@ name ["syshostname"]: in the X Toolkit Intrinsics - C Language Interface manual is also permitted). They must be registered as conffiles or handled as - configuration files. Packages must not provide the - directory /usr/X11R6/lib/X11/app-defaults/. + configuration files.

@@ -8289,12 +8570,6 @@ name ["syshostname"]: are stored in the X server and affect all connecting clients. - Important: packages that install files into the - /etc/X11/Xresources/ directory must conflict with - xbase (<< 3.3.2.3a-2); if this is not done - it is possible for the installing package to destroy a - previously-existing /etc/X11/Xresources file - which had been customized by the system administrator.

@@ -8302,54 +8577,34 @@ name ["syshostname"]: Installation directory issues

- Packages using the X Window System should not be - configured to install files under the - /usr/X11R6/ directory. The - /usr/X11R6/ directory hierarchy should be + Historically, packages using the X Window System used a + separate set of installation directories from other packages. + This practice has been discontinued and packages using the X + Window System should now generally be installed in the same + directories as any other package. Specifically, packages must + not install files under the /usr/X11R6/ directory + and the /usr/X11R6/ directory hierarchy should be regarded as obsolete.

- Programs that use GNU autoconf and - automake are usually easily configured at - compile time to use /usr/ instead of - /usr/X11R6/, and this should be done whenever - possible. Configuration files for window managers and - display managers should be placed in a subdirectory of - /etc/X11/ corresponding to the package name due - to these programs' tight integration with the mechanisms - of the X Window System. Application-level programs should - use the /etc/ directory unless otherwise mandated - by policy. -

- -

- The installation of files into subdirectories - of /usr/X11R6/include/X11/ and - /usr/X11R6/lib/X11/ is now prohibited; - package maintainers should determine if subdirectories of - /usr/lib/ and /usr/share/ can be used - instead. + Include files previously installed under + /usr/X11R6/include/X11/ should be installed into + /usr/include/X11/. For files previously + installed into subdirectories of + /usr/X11R6/lib/X11/, package maintainers should + determine if subdirectories of /usr/lib/ and + /usr/share/ can be used. If not, a subdirectory + of /usr/lib/X11/ should be used.

- Packages should install any relevant files into the - directories /usr/include/X11/ and - /usr/lib/X11/, but if they do so, they must - pre-depend on x11-common (>= - 1:7.0.0) -

- These libraries used to be all symbolic - links. However, with X11R7, - /usr/include/X11 and /usr/lib/X11 - are now real directories, and packages - should ship their files here instead - of in /usr/X11R6/{include,lib}/X11. - x11-common (>= 1:7.0.0) is the package - responsible for converting these symlinks into - directories. -

- + Configuration files for window managers and display managers + should be placed in a subdirectory of /etc/X11/ + corresponding to the package name due to these programs' tight + integration with the mechanisms of the X Window System. + Application-level programs should use the /etc/ + directory unless otherwise mandated by policy.

@@ -8438,8 +8693,8 @@ name ["syshostname"]: Games which require protected, privileged access to high-score files, saved games, etc., may be made set-group-id (mode 2755) and owned by - root.games, and use files and directories with - appropriate permissions (770 root.games, for + root:games, and use files and directories with + appropriate permissions (770 root:games, for example). They must not be made set-user-id, as this causes security problems. (If an attacker can subvert any set-user-id game they can @@ -8737,7 +8992,15 @@ install-info --quiet --remove /usr/share/info/foobar.info In addition, the copyright file must say where the upstream sources (if any) were obtained. It should name the original authors of the package and the Debian maintainer(s) who were - involved with its creation.

+ involved with its creation. +

+ +

+ Packages in the contrib or non-free archive + areas should state in the copyright file that the package is not + part of the Debian GNU/Linux distribution and briefly explain + why. +

A copy of the file which will be installed in @@ -8755,21 +9018,23 @@ install-info --quiet --remove /usr/share/info/foobar.info

- Packages distributed under the UCB BSD license, the Artistic - license, the GNU GPL (version 2 or 3), the GNU LGPL (versions - 2, 2.1, or 3), and the GNU FDL (version 1.2) should refer to - the corresponding files under - /usr/share/common-licenses, + Packages distributed under the UCB BSD license, the Apache + license (version 2.0), the Artistic license, the GNU GPL + (version 2 or 3), the GNU LGPL (versions 2, 2.1, or 3), and the + GNU FDL (versions 1.2 or 1.3) should refer to the corresponding + files under /usr/share/common-licenses,

In particular, /usr/share/common-licenses/BSD, + /usr/share/common-licenses/Apache-2.0, /usr/share/common-licenses/Artistic, /usr/share/common-licenses/GPL-2, /usr/share/common-licenses/GPL-3, /usr/share/common-licenses/LGPL-2, /usr/share/common-licenses/LGPL-2.1, - /usr/share/common-licenses/LGPL-3, and - /usr/share/common-licenses/GFDL-1.2, + /usr/share/common-licenses/LGPL-3, + /usr/share/common-licenses/GFDL-1.2, and + /usr/share/common-licenses/GFDL-1.3 respectively.

rather than quoting them in the copyright @@ -9054,7 +9319,7 @@ install-info --quiet --remove /usr/share/info/foobar.info To view the copyright file for a package you could use this command: - dpkg --fsys-tarfile filename.deb | tar xOf - \*/copyright | pager + dpkg --fsys-tarfile filename.deb | tar xOf - --wildcards \*/copyright | pager

@@ -9406,13 +9671,8 @@ install-info --quiet --remove /usr/share/info/foobar.info

- Its arguments are executables. + Its arguments are executables and shared libraries -

- In a forthcoming dpkg version, - dpkg-shlibdeps would be required to be - called on shared libraries as well. -

They may be specified either in the locations in the source tree where they are created or in the locations @@ -9460,7 +9720,7 @@ install-info --quiet --remove /usr/share/info/foobar.info and then in its main control file debian/control: ... - Depends: ${shlibs:Pre-Depends} + Depends: ${shlibs:Depends} Recommends: ${shlibs:Recommends} ... @@ -9569,8 +9829,8 @@ install-info --quiet --remove /usr/share/info/foobar.info

This program can be used manually, but is also invoked by dpkg-buildpackage or debian/rules to set - to set environment or make variables which specify the build and - host architecture for the package building process. + environment or make variables which specify the build and host + architecture for the package building process.

@@ -9611,36 +9871,6 @@ install-info --quiet --remove /usr/share/info/foobar.info See .

-

- It is recommended that the entire changelog be encoded in the - - encoding of - . -

- I think it is fairly obvious that we need to - eventually transition to UTF-8 for our package - infrastructure; it is really the only sane char-set in - an international environment. Now, we can't switch to - using UTF-8 for package control fields and the like - until dpkg has better support, but one thing we can - start doing today is requesting that Debian changelogs - are UTF-8 encoded. At some point in time, we can start - requiring them to do so. -

-

- Checking for non-UTF8 characters in a changelog is - trivial. Dump the file through - iconv -f utf-8 -t ucs-4 - discard the output, and check the return - value. If there are any characters in the stream - which are invalid UTF-8 sequences, iconv will exit - with an error code; and this will be the case for the - vast majority of other character sets. -

- -

- Defining alternative changelog formats @@ -10353,26 +10583,48 @@ install-info --quiet --remove /usr/share/info/foobar.info supposing that a smailwrapper package wishes to install a wrapper around /usr/sbin/smail: - if [ install = "$1" ]; then - dpkg-divert --package smailwrapper --add --rename \ - --divert /usr/sbin/smail.real /usr/sbin/smail - fi - Testing $1 is necessary so that the script - doesn't try to add the diversion again when - smailwrapper is upgraded. The --package - smailwrapper ensures that smailwrapper's - copy of /usr/sbin/smail can bypass the diversion and - get installed as the true version. + dpkg-divert --package smailwrapper --add --rename \ + --divert /usr/sbin/smail.real /usr/sbin/smail + The --package smailwrapper ensures that + smailwrapper's copy of /usr/sbin/smail + can bypass the diversion and get installed as the true version. + It's safe to add the diversion unconditionally on upgrades since + it will be left unchanged if it already exists, but + dpkg-divert will display a message. To suppress that + message, make the command conditional on the version from which + the package is being upgraded: + + if [ upgrade != "$1" ] || dpkg --compare-versions "$2" lt 1.0-2; then + dpkg-divert --package smailwrapper --add --rename \ + --divert /usr/sbin/smail.real /usr/sbin/smail + fi + where 1.0-2 is the version at which the + diversion was first added to the package. Running the command + during abort-upgrade is pointless but harmless.

The postrm has to do the reverse: - if [ remove = "$1" ]; then + if [ remove = "$1" -o abort-install = "$1" -o disappear = "$1" ]; then + dpkg-divert --package smailwrapper --remove --rename \ + --divert /usr/sbin/smail.real /usr/sbin/smail + fi + If the diversion was added at a particular version, the + postrm should also handle the failure case of upgrading from an + older version (unless the older version is so old that direct + upgrades are no longer supported): + + if [ abort-upgrade = "$1" ] && dpkg --compare-versions "$2" lt 1.0-2; then dpkg-divert --package smailwrapper --remove --rename \ --divert /usr/sbin/smail.real /usr/sbin/smail fi - + where 1.02-2 is the version at which the + diversion was first added to the package. The postrm should not + remove the diversion on upgrades both because there's no reason to + remove the diversion only to immediately re-add it and since the + postrm of the old package is run after unpacking so the removal of + the diversion will fail.