X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;ds=sidebyside;f=policy.sgml;h=4246954a59bf7d3849bb908c4f96aaad0f4b1ae3;hb=be728601beaa04416d44dc68126f3e92a275f3dd;hp=8f02c12cbf4d6e734838dfa45f1d7a5910fe0b70;hpb=1884e1727a6255b3d087db65cf0fcc37d3e77355;p=debian%2Fdebian-policy.git
diff --git a/policy.sgml b/policy.sgml
index 8f02c12..4246954 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
@@ -670,18 +677,20 @@
The Debian archive maintainers provide the authoritative
list of sections. At present, they are:
- admin, comm,
- devel, doc,
- editors, electronics, embedded,
- games, gnome, graphics,
- hamradio, interpreters, kde,
- libs, libdevel, mail,
- math, misc, net, news,
- 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.
@@ -1983,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)
@@ -2011,8 +2026,10 @@
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.
@@ -2586,6 +2603,15 @@ Package: libc6
package control file when the source package has the same
name and version as the binary package.
+
+
+ Package names (both source and binary,
+ see [) 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.
+ ]
@@ -2683,11 +2709,9 @@ Package: libc6
- 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.
+ Binary package names must follow the same syntax and
+ restrictions as source package names. See [
+ for the details.
]
@@ -2700,7 +2724,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
@@ -2711,31 +2735,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.
@@ -2743,7 +2789,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.
@@ -3074,76 +3124,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.
@@ -3277,15 +3290,17 @@ Package: libc6
Installed-Size
- This field appears in the control files of binary
- packages, and in the Packages files. It gives
- the total amount of disk space required to install the
- named package.
+ This field appears in the control files of binary packages,
+ and in the Packages files. It gives an
+ estimate the total amount of disk space required to install
+ the named package. Actual installed size may vary based on
+ block size, file system properties, or actions taken by
+ package maintainer scripts.
- The disk space is represented in kilobytes as a simple
- decimal number.
+ The disk space is given as the integer value of the estimated
+ installed size in bytes, divided by 1024 and rounded up.
@@ -4245,6 +4260,9 @@ Build-Depends: foo [!i386] | bar [!amd64]
This is done using the Depends, Pre-Depends,
Recommends, Suggests, Enhances,
Breaks and Conflicts control file fields.
+ Breaks is described in [, and
+ Conflicts is described in ][. The
+ rest are described below.
]
@@ -4432,12 +4450,6 @@ Build-Depends: foo [!i386] | bar [!amd64]
Packages which break other packages - Breaks
-
- Using Breaks may cause problems for upgrades from older
- versions of Debian and should not be used until the stable
- release of Debian supports Breaks.
-
-
When one binary package declares that it breaks another,
dpkg will refuse to allow the package which
@@ -4522,8 +4534,7 @@ Build-Depends: foo [!i386] | bar [!amd64]
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. Instead,
- Breaks may be used (once Breaks is supported
- by the stable release of Debian).
+ Breaks may be used.
@@ -5524,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
@@ -5702,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.
@@ -6983,17 +6981,6 @@ strip --strip-unneeded your-lib
-
- Packages containing shared libraries that may be linked to
- by other packages' binaries, but which for some
- compelling reason can not be installed in
- /usr/lib directory, may install the shared library
- files in subdirectories of the /usr/lib directory,
- in which case they should arrange to add that directory in
- /etc/ld.so.conf in the package's post-installation
- script, and remove it in the package's post-removal script.
-
-
An ever increasing number of packages are using
libtool to do their linking. The latest GNU
@@ -8424,11 +8411,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
@@ -8440,9 +8422,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.)
-
@@ -8551,7 +8533,7 @@ name ["syshostname"]:
-
+
Application defaults files
@@ -8584,54 +8566,35 @@ 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, display, or session managers
+ or other applications that are tightly integrated with the X
+ Window System may be placed in a subdirectory
+ of /etc/X11/ corresponding to the package name.
+ Other X Window System applications should use
+ the /etc/ directory unless otherwise mandated by
+ policy (such as for [).
]
@@ -8863,6 +8826,15 @@ name ["syshostname"]:
characters outside that range may be found in
.
+
+
+ If a localized version of a manual page is provided, it should
+ either be up-to-date or it should be obvious to the reader that
+ it is outdated and the original manual page should be used
+ instead. This can be done either by a note at the beginning of
+ the manual page or by showing the missing or changed portions in
+ the original language instead of the target language.
+
@@ -8874,37 +8846,49 @@ name ["syshostname"]:
- Your package should call install-info to update
- the Info dir file in its postinst
- script when called with a configure argument, for
- example:
-
-install-info --quiet --section Development Development \
- /usr/share/info/foobar.info
-
-
-
- It is a good idea to specify a section for the location of
- your program; this is done with the --section
- switch. To determine which section to use, you should look
- at /usr/share/info/dir on your system and choose the most
- relevant (or create a new section if none of the current
- sections are relevant). Note that the --section
- flag takes two arguments; the first is a regular expression
- to match (case-insensitively) against an existing section,
- the second is used when creating a new one.
-
-
- You should remove the entries in the prerm
- script when called with a remove argument:
-
-install-info --quiet --remove /usr/share/info/foobar.info
-
+ The install-info program maintains a directory of
+ installed info documents in /usr/share/info/dir for
+ the use of info readers.
+ It was previously necessary for packages installing info
+ documents to run install-info from maintainer
+ scripts. This is no longer necessary. The installation
+ system now uses dpkg hooks.
+
+ This file must not be included in packages.
+
- If install-info cannot find a description entry
- in the Info file you must supply one. See for details.
+ Info documents should contain section and directory entry
+ information in the document for the use
+ of install-info. The section should be specified
+ via a line starting with INFO-DIR-SECTION followed by a
+ space and the section of this info page. The directory entry or
+ entries should be included between
+ a START-INFO-DIR-ENTRY line and
+ an END-INFO-DIR-ENTRY line. For example:
+
+INFO-DIR-SECTION Individual utilities
+START-INFO-DIR-ENTRY
+* example: (example). An example info directory entry.
+END-INFO-DIR-ENTRY
+
+ To determine which section to use, you should look
+ at /usr/share/info/dir on your system and choose
+ the most relevant (or create a new section if none of the
+ current sections are relevant).
+ Normally, info documents are generated from Texinfo source.
+ To include this information in the generated info document, if
+ it is absent, add commands like:
+
+@dircategory Individual utilities
+@direntry
+* example: (example). An example info directory entry.
+@end direntry
+
+
+ to the Texinfo source of the document and ensure that the info
+ documents are rebuilt from source during the package build.
+
@@ -9047,8 +9031,8 @@ install-info --quiet --remove /usr/share/info/foobar.info
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 (version 1.2) should refer to the corresponding
+ (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,
@@ -9059,8 +9043,9 @@ install-info --quiet --remove /usr/share/info/foobar.info
/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