X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=policy.sgml;h=83d42a9f38b15210852ace0932ec427480d4dc3f;hb=ba95502cd0565d860bf41a70e5dddacd93d4dad4;hp=07b3a067619a522ff81f4903133316e2e533bb87;hpb=93d621ce37d21e34aba3ac29d324e08e249fcee7;p=debian%2Fdebian-policy.git diff --git a/policy.sgml b/policy.sgml index 07b3a06..83d42a9 100644 --- a/policy.sgml +++ b/policy.sgml @@ -802,6 +802,35 @@ in the .deb file format.

+

+ A .deb package contains two sets of files: a set of files + to install on the system when the package is installed, and a set + of files that provide additional metadata about the package or + which are executed when the package is installed or removed. This + second set of files is called control information files. + Among those files are the package maintainer scripts + and control, the binary + package control file that contains the control fields for + the package. Other control information files + include the shlibs + file used to store shared library dependency information + and the conffiles file that lists the package's + configuration files (described in ). +

+ +

+ There is unfortunately a collision of terminology here between + control information files and files in the Debian control file + format. Throughout this document, a control file refers + to a file in the Debian control file format. These files are + documented in . Only files referred to + specifically as control information files are the files + included in the control information file member of + the .deb file format used by binary packages. Most + control information files are not in the Debian control file + format. +

+ The package name @@ -921,9 +950,9 @@ The description of a package

- Every Debian package must have an extended description - stored in the appropriate field of the control record. - The technical information about the format of the + Every Debian package must have a Description control + field which contains a synopsis and extended description of the + package. Technical information about the format of the Description field is in .

@@ -1135,7 +1164,7 @@ 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. The format of the Essential control field is described in .

@@ -1255,17 +1284,16 @@

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. - See . - . - The config script might be run before the - preinst script, and before the package is unpacked - or any of its dependencies or pre-dependencies are satisfied. - Therefore it must work using only the tools present in - essential packages. + Specification may contain the additional control information + files config + and templates. config is an + additional maintainer script used for package configuration, + and templates contains templates used for user + prompting. The config script might be run before + the preinst script and before the package is + unpacked or any of its dependencies or pre-dependencies are + satisfied. 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 @@ -1608,7 +1636,15 @@ The maintainer name and email address used in the changelog should be the details of the person uploading this version. They are not necessarily those of the - usual package maintainer. The information here will be + usual package maintainer + If the developer uploading the package is not one of the usual + maintainers of the package (as listed in the + Maintainer or + Uploaders control fields of + the package), the first line of the changelog is conventionally used + to explain why a non-maintainer is uploading the package. The + Debian Developer's Reference (see ) documents the + conventions used.. The information here will be copied to the Changed-By field in the .changes file (see ), and then later used to send an acknowledgement when the @@ -2190,16 +2226,16 @@ endif Variable substitutions: debian/substvars

- When dpkg-gencontrol, - dpkg-genchanges and dpkg-source - generate control files they perform variable substitutions - on their output just before writing it. Variable + When dpkg-gencontrol + generates binary package control + files (DEBIAN/control), it performs variable + substitutions on its output just before writing it. Variable substitutions have the form ${variable}. The optional file debian/substvars contains variable substitutions to be used; variables can also be set directly from debian/rules using the -V - option to the source packaging commands, and certain - predefined variables are also available. + option to the source packaging commands, and certain predefined + variables are also available.

@@ -2218,12 +2254,12 @@ endif Optional upstream source location: debian/watch

- This is an optional, recommended control file for the - uscan utility which defines how to automatically - scan ftp or http sites for newly available updates of the - package. This is used by and other Debian QA tools - to help with quality control and maintenance of the + This is an optional, recommended configuration file for the + uscan utility which defines how to automatically scan + ftp or http sites for newly available updates of the + package. This is used + by and other Debian QA + tools to help with quality control and maintenance of the distribution as a whole.

@@ -3610,12 +3646,11 @@ Checksums-Sha256:

- These scripts are the files preinst, - postinst, prerm and - postrm in the control area of the package. - They must be proper executable files; if they are scripts - (which is recommended), they must start with the usual - #! convention. They should be readable and + These scripts are the control information + files preinst, postinst, prerm + and postrm. They must be proper executable files; + if they are scripts (which is recommended), they must start with + the usual #! convention. They should be readable and executable by anyone, and must not be world-writable.

@@ -3630,12 +3665,12 @@ Checksums-Sha256: they exit with a zero status if everything went well.

-

- Additionally, packages interacting with users using - debconf in the postinst script should - install a config script in the control area, - see for details. -

+

+ Additionally, packages interacting with users + using debconf in the postinst script + should install a config script as a control + information file. See for details. +

When a package is upgraded a combination of the scripts from @@ -4311,7 +4346,7 @@ Checksums-Sha256: In the Depends, Recommends, Suggests, Pre-Depends, Build-Depends and Build-Depends-Indep - control file fields of the package, which declare + control fields of the package, which declare dependencies on other packages, the package names listed may also include lists of alternative package names, separated by vertical bar (pipe) symbols |. In such a case, @@ -4475,7 +4510,7 @@ Build-Depends: foo [linux-any], bar [any-i386], baz [!linux-any]

This is done using the Depends, Pre-Depends, Recommends, Suggests, Enhances, - Breaks and Conflicts control file fields. + Breaks and Conflicts control fields. Breaks is described in , and Conflicts is described in . The rest are described below. @@ -4833,11 +4868,10 @@ Build-Depends: foo [linux-any], bar [any-i386], baz [!linux-any]

A virtual package is one which appears in the - Provides control file field of another package. - The effect is as if the package(s) which provide a - particular virtual package name had been listed by name - everywhere the virtual package name appears. (See also ) + Provides control field of another package. The effect + is as if the package(s) which provide a particular virtual + package name had been listed by name everywhere the virtual + package name appears. (See also )

@@ -4905,9 +4939,9 @@ Provides: bar

Packages can declare in their control file that they should - overwrite files in certain other packages, or completely - replace other packages. The Replaces control file - field has these two distinct purposes. + overwrite files in certain other packages, or completely replace + other packages. The Replaces control field has these + two distinct purposes.

Overwriting files in other packages @@ -5034,7 +5068,7 @@ Replaces: mail-transport-agent

This is done using the Build-Depends, Build-Depends-Indep, Build-Conflicts and - Build-Conflicts-Indep control file fields. + Build-Conflicts-Indep control fields.

@@ -5098,55 +5132,134 @@ Replaces: mail-transport-agent

- Packages involving shared libraries should be split up into - several binary packages. This section mostly deals with how - this separation is to be accomplished; rules for files within - the shared library packages are in instead. + This section deals only with public shared libraries: shared + libraries that are placed in directories searched by the dynamic + linker by default or which are intended to be linked against + normally and possibly used by other, independent packages. Shared + libraries that are internal to a particular package or that are + only loaded as dynamic modules are not covered by this section and + are not subject to its requirements.

- - Run-time shared libraries +

+ A shared library is identified by the SONAME attribute + stored in its dynamic section. When a binary is linked against a + shared library, the SONAME of the shared library is + recorded in the binary's NEEDED section so that the + dynamic linker knows that library must be loaded at runtime. The + shared library file's full name (which usually contains additional + version information not needed in the SONAME) is + therefore normally not referenced directly. Instead, the shared + library is loaded by its SONAME, which exists on the file + system as a symlink pointing to the full name of the shared + library. This symlink must be provided by the + package. describes how to do this. + + This is a convention of shared library versioning, but not a + requirement. Some libraries use the SONAME as the full + library file name instead and therefore do not need a symlink. + Most, however, encode additional information about + backwards-compatible revisions as a minor version number in the + file name. The SONAME itself only changes when + binaries linked with the earlier version of the shared library + may no longer work, but the filename may change with each + release of the library. See for + more information. + +

- The run-time shared library needs to be placed in a package - whose name changes whenever the shared object version - changes. -

- Since it is common place to install several versions of a - package that just provides shared libraries, it is a - good idea that the library package should not - contain any extraneous non-versioned files, unless they - happen to be in versioned directories.

- - The most common mechanism is to place it in a package - called - librarynamesoversion, - where soversion is the version number - in the soname of the shared library - The soname is the shared object name: it's the thing - that has to match exactly between building an executable - and running it for the dynamic linker to be able run the - program. For example, if the soname of the library is - libfoo.so.6, the library package would be - called libfoo6. - . - Alternatively, if it would be confusing to directly append - soversion to libraryname (e.g. because - libraryname itself ends in a number), you may use - libraryname-soversion and - libraryname-soversion-dev - instead. + When linking a binary or another shared library against a shared + library, the SONAME for that shared library is not yet + known. Instead, the shared library is found by looking for a file + matching the library name with .so appended. This file + exists on the file system as a symlink pointing to the shared + library. +

+ +

+ Shared libraries are normally split into several binary packages. + The SONAME symlink is installed by the runtime shared + library package, and the bare .so symlink is installed in + the development package since it's only used when linking binaries + or shared libraries. However, there are some exceptions for + unusual shared libraries or for shared libraries that are also + loaded as dynamic modules by other programs.

- If you have several shared libraries built from the same - source tree you may lump them all together into a single - shared library package, provided that you change all of - their sonames at once (so that you don't get filename - clashes if you try to install different versions of the - combined shared libraries package). + This section is primarily concerned with how the separation of + shared libraries into multiple packages should be done and how + dependencies on and between shared library binary packages are + managed in Debian. should be read in + conjunction with this section and contains additional rules for + the files contained in the shared library packages.

+ + Run-time shared libraries + +

+ The run-time shared library must be placed in a package + whose name changes whenever the SONAME of the shared + library changes. This allows several versions of the shared + library to be installed at the same time, allowing installation + of the new version of the shared library without immediately + breaking binaries that depend on the old version. Normally, the + run-time shared library and its SONAME symlink should + be placed in a package named + librarynamesoversion, + where soversion is the version number in + the SONAME of the shared library. + See for detailed information on how to + determine this version. Alternatively, if it would be confusing + to directly append soversion + to libraryname (if, for example, libraryname + itself ends in a number), you should use + libraryname-soversion + instead. +

+ +

+ If you have several shared libraries built from the same source + tree, you may lump them all together into a single shared + library package provided that all of their SONAMEs will + always change together. Be aware that this is not normally the + case, and if the SONAMEs do not change together, + upgrading such a merged shared library package will be + unnecessarily difficult because of file conflicts with the old + version of the package. When in doubt, always split shared + library packages so that each binary package installs a single + shared library. +

+ +

+ Every time the shared library ABI changes in a way that may + break binaries linked against older versions of the shared + library, the SONAME of the library and the + corresponding name for the binary package containing the runtime + shared library should change. Normally, this means + the SONAME should change any time an interface is + removed from the shared library or the signature of an interface + (the number of parameters or the types of parameters that it + takes, for example) is changed. This practice is vital to + allowing clean upgrades from older versions of the package and + clean transitions between the old ABI and new ABI without having + to upgrade every affected package simultaneously. +

+ +

+ The SONAME and binary package name need not, and indeed + normally should not, change if new interfaces are added but none + are removed or changed, since this will not break binaries + linked against the old shared library. Correct versioning of + dependencies on the newer shared library by binaries that use + the new interfaces is handled via + the shlibs + system or via symbols files (see + ). +

+

The package should install the shared libraries under their normal names. For example, the libgdbm3 @@ -5166,10 +5279,11 @@ Replaces: mail-transport-agent

- The run-time library package should include the symbolic link that - ldconfig would create for the shared libraries. - For example, the libgdbm3 package should include - a symbolic link from /usr/lib/libgdbm.so.3 to + The run-time library package should include the symbolic link for + the SONAME that ldconfig would create for + the shared libraries. For example, + the libgdbm3 package should include a symbolic + link from /usr/lib/libgdbm.so.3 to libgdbm.so.3.0.0. This is needed so that the dynamic linker (for example ld.so or ld-linux.so.*) can find the library between the @@ -5389,6 +5503,14 @@ Replaces: mail-transport-agent (ld) when compiling packages, as it will only look for libgdbm.so when compiling dynamically.

+ +

+ If the package provides Ada Library Information + (*.ali) files for use with GNAT, these files must be + installed read-only (mode 0444) so that GNAT will not attempt to + recompile them. This overrides the normal file mode requirements + given in . +

@@ -5525,10 +5647,10 @@ Replaces: mail-transport-agent

When packages are being built, any debian/shlibs files are copied into the - control file area of the temporary build directory and - given the name shlibs. These files give - details of any shared libraries included in the same - package. + control information file area of the temporary build + directory and given the name shlibs. These + files give details of any shared libraries included in the + same package. An example may help here. Let us say that the source package foo generates two binary packages, libfoo2 and foo-runtime. @@ -5729,7 +5851,8 @@ udeb: libz 1 zlib1g-udeb (>= 1:1.1.3) It is usual to call this file debian/shlibs (but if you have multiple binary packages, you might want to call it debian/shlibs.package instead). Then - let debian/rules install it in the control area: + let debian/rules install it in the control + information file area: install -m644 debian/shlibs debian/tmp/DEBIAN @@ -5738,9 +5861,9 @@ install -m644 debian/shlibs debian/tmp/DEBIAN install -m644 debian/shlibs.package debian/package/DEBIAN/shlibs An alternative way of doing this is to create the - shlibs file in the control area directly from - debian/rules without using a debian/shlibs - file at all, + shlibs file in the control information file area + directly from debian/rules without using + a debian/shlibs file at all, This is what dh_makeshlibs in the debhelper suite does. If your package also has a udeb that provides a shared @@ -7454,7 +7577,19 @@ fname () { must be supported and must set the value of c to delta. - + + The XSI extension to kill allowing kill + -signal, where signal is either + the name of a signal or one of the numeric signals listed in + the XSI extension (0, 1, 2, 3, 6, 9, 14, and 15), must be + supported if kill is implemented as a shell + built-in. + + The XSI extension to trap allowing numeric + signals must be supported. In addition to the signal + numbers listed in the extension, which are the same as for + kill above, 13 (SIGPIPE) must be allowed. + If a shell script requires non-SUSv3 features from the shell interpreter other than those listed above, the appropriate shell @@ -7951,7 +8086,7 @@ ln -fs ../sbin/sendmail debian/tmp/usr/bin/runq

- + Permissions and owners

@@ -7992,6 +8127,12 @@ ln -fs ../sbin/sendmail debian/tmp/usr/bin/runq

+

+ Control information files should be owned by root:root + and either mode 644 (for most files) or mode 755 (for + executables such as maintainer + scripts). +

Setuid and setgid executables should be mode 4755 or 2755 @@ -8496,8 +8637,7 @@ http://localhost/doc/package/filename this so programs should not fail if newaliases cannot be found. Note that because of this, all MTA packages must have Provides, Conflicts and - Replaces: mail-transport-agent control file - fields. + Replaces: mail-transport-agent control fields.

@@ -8606,8 +8746,9 @@ name ["syshostname"]:

Packages that provide an X server that, directly or indirectly, communicates with real input and display - hardware should declare in their control data that they - provide the virtual package xserver. + hardware should declare in their Provides control + field that they provide the virtual + package xserver. This implements current practice, and provides an actual policy for usage of the xserver virtual package which appears in the virtual packages @@ -8625,10 +8766,10 @@ name ["syshostname"]:

Packages that provide a terminal emulator for the X Window - System which meet the criteria listed below should declare - in their control data that they provide the virtual - package x-terminal-emulator. They should also - register themselves as an alternative for + System which meet the criteria listed below should declare in + their Provides control field that they provide the + virtual package x-terminal-emulator. They should + also register themselves as an alternative for /usr/bin/x-terminal-emulator, with a priority of 20. That alternative should have a slave alternative for /usr/share/man/man1/x-terminal-emulator.1.gz @@ -8673,9 +8814,9 @@ name ["syshostname"]:

Packages that provide a window manager should declare in - their control data that they provide the virtual package - x-window-manager. They should also register - themselves as an alternative for + their Provides control field that they provide the + virtual package x-window-manager. They should also + register themselves as an alternative for /usr/bin/x-window-manager, with a priority calculated as follows: @@ -8851,8 +8992,8 @@ name ["syshostname"]: Font packages must declare a dependency on - xfonts-utils in their control - data. + xfonts-utils in their Depends + or Pre-Depends control field. @@ -9720,13 +9861,13 @@ END-INFO-DIR-ENTRY

It is possible to put other files in the package control - area, but this is not generally a good idea (though they - will largely be ignored). + information file area, but this is not generally a good idea + (though they will largely be ignored).

- Here is a brief list of the control info files supported by - dpkg and a summary of what they're used for. + Here is a brief list of the control information files supported + by dpkg and a summary of what they're used for.

@@ -10597,7 +10738,7 @@ END-INFO-DIR-ENTRY Package_Revision The Debian revision part of the package version was - at one point in a separate control file field. This + at one point in a separate control field. This field went through several names. @@ -10654,7 +10795,7 @@ END-INFO-DIR-ENTRY

- A package may contain a control area file called + A package may contain a control information file called conffiles. This file should be a list of filenames of configuration files needing automatic handling, separated by newlines. The filenames should be absolute pathnames,