Checksums-Sha1
@@ -3738,6 +3783,53 @@ Checksums-Sha256:
details.
+
+
+ Version Control System (VCS) fields
+
+
+ Debian source packages are increasingly developed using VCSs. The
+ purpose of the following fields is to indicate a publicly accessible
+ repository where the Debian source package is developed.
+
+
+ Vcs-Browser
+ -
+
+ URL of a web interface for browsing the repository.
+
+
+
+
+ Vcs-Arch, Vcs-Bzr (Bazaar), Vcs-Cvs,
+ Vcs-Darcs, Vcs-Git, Vcs-Hg
+ (Mercurial), Vcs-Mtn (Monotone), Vcs-Svn
+ (Subversion)
+
+ -
+
+ The field name identifies the VCS. The field's value uses the
+ version control system's conventional syntax for describing
+ repository locations and should be sufficient to locate the
+ repository used for packaging. Ideally, it also locates the
+ branch used for development of new versions of the Debian
+ package.
+
+
+ In the case of Git, the value consists of a URL, optionally
+ followed by the word -b and the name of a branch in
+ the indicated repository, following the syntax of the
+ git clone command. If no branch is specified, the
+ packaging should be on the default branch.
+
+
+ More than one different VCS may be specified for the same
+ package.
+
+
+
+
+
@@ -4608,13 +4700,13 @@ fi
The relations allowed are <<, <=,
- =, >= and >> for
- strictly earlier, earlier or equal, exactly equal, later or
- equal and strictly later, respectively. The deprecated
- forms < and > were used to mean
- earlier/later or equal, rather than strictly earlier/later,
- so they should not appear in new packages (though
- dpkg still supports them).
+ =, >= and >> for strictly
+ earlier, earlier or equal, exactly equal, later or equal and
+ strictly later, respectively. The deprecated
+ forms < and > were confusingly used to
+ mean earlier/later or equal, rather than strictly earlier/later,
+ and must not appear in new packages (though dpkg
+ still supports them with a warning).
@@ -4678,7 +4770,8 @@ Build-Depends: kernel-headers-2.2.10 [!hurd-i386],
- For binary relationship fields, the architecture restriction
+ For binary relationship fields and the Built-Using
+ field, the architecture restriction
syntax is only supported in the source package control
file debian/control. When the corresponding binary
package control file is generated, the relationship will either
@@ -5402,6 +5495,53 @@ Replaces: mail-transport-agent
+
+
+ Additional source packages used to build the binary
+ - Built-Using
+
+
+
+ Some binary packages incorporate parts of other packages when built
+ but do not have to depend on those packages. Examples include
+ linking with static libraries or incorporating source code from
+ another package during the build. In this case, the source packages
+ of those other packages are a required part of the complete source
+ (the binary package is not reproducible without them).
+
+
+
+ A Built-Using field must list the corresponding source
+ package for any such binary package incorporated during the build
+
+ Build-Depends in the source package is not adequate since
+ it (rightfully) does not document the exact version used in the
+ build.
+ ,
+ including an "exactly equal" ("=") version relation on the version
+ that was used to build that binary package
+ The archive software might reject packages that refer to
+ non-existent sources.
+ .
+
+
+
+ A package using the source code from the gcc-4.6-source
+ binary package built from the gcc-4.6 source package would
+ have this field in its control file:
+
+Built-Using: gcc-4.6 (= 4.6.0-11)
+
+
+
+
+ A package including binaries from grub2 and loadlin would
+ have this field in its control file:
+
+Built-Using: grub2 (= 1.99-9), loadlin (= 1.6e-1)
+
+
+
@@ -5506,7 +5646,7 @@ Replaces: mail-transport-agent
To determine the soversion, look at
the SONAME of the library, stored in the
- ELF SONAME attribute. it is usually of the
+ ELF SONAME attribute. It is usually of the
form name.so.major-version (for
example, libz.so.1). The version part is the part
which comes after .so., so in that example it
@@ -5832,30 +5972,43 @@ Replaces: mail-transport-agent
installed. These dependencies must be added to the binary
package when it is built, since they may change based on which
version of a shared library the binary or library was linked
- with. To allow these dependencies to be constructed, shared
- libraries must provide either a symbols file or
- a shlibs file, which provide information on the
- package dependencies required to ensure the presence of this
- library. Any package which uses a shared library must use these
- files to determine the required dependencies when it is built.
-
-
-
- These two mechanisms differ in the degree of detail that they
- provide. A symbols file documents every symbol
- that is part of the library ABI and, for each, the version of
- the package in which it was introduced. This permits detailed
- analysis of the symbols used by a particular package and
- construction of an accurate dependency, but it requires the
- package maintainer to track more information about the shared
- library. A shlibs file, in contrast, only
- documents the last time the library ABI changed in any way. It
- only provides information about the library as a whole, not
- individual symbols. When a package is built using a shared
- library with only a shlibs file, the generated
- dependency will require a version of the shared library equal to
- or newer than the version of the last ABI change. This
- generates unnecessarily restrictive dependencies compared
+ with even if there are no changes to the source of the binary
+ (for example, symbol versions change, macros become functions or
+ vice versa, or the binary package may determine at compile-time
+ whether new library interfaces are available and can be called).
+ To allow these dependencies to be constructed, shared libraries
+ must provide either a symbols file or
+ a shlibs file. These provide information on the
+ package dependencies required to ensure the presence of
+ interfaces provided by this library. Any package with binaries
+ or libraries linking to a shared library must use these files to
+ determine the required dependencies when it is built. Other
+ packages which use a shared library (for example using
+ dlopen()) should compute appropriate dependencies
+ using these files at build time as well.
+
+
+
+ The two mechanisms differ in the degree of detail that they
+ provide. A symbols file documents, for each symbol
+ exported by a library, the minimal version of the package any
+ binary using this symbol will need. This is typically the
+ version of the package in which the symbol was introduced. This
+ information permits detailed analysis of the symbols used by a
+ particular package and construction of an accurate dependency,
+ but it requires the package maintainer to track more information
+ about the shared library.
+
+
+
+ A shlibs file, in contrast, only documents the last
+ time the library ABI changed in any way. It only provides
+ information about the library as a whole, not individual
+ symbols. When a package is built using a shared library with
+ only a shlibs file, the generated dependency will
+ require a version of the shared library equal to or newer than
+ the version of the last ABI change. This generates
+ unnecessarily restrictive dependencies compared
to symbols files if none of the symbols used by the
package have changed. This, in turn, may make upgrades
needlessly complex and unnecessarily restrict use of the package
@@ -5863,9 +6016,16 @@ Replaces: mail-transport-agent
- shlibs files also have a flawed representation of
+ shlibs files also only support a limited range of
library SONAMEs, making it difficult to use shlibs
- files in some unusual corner cases.
+ files in some unusual corner cases.
+ A shlibs file represents an SONAME as a library
+ name and version number, such as libfoo VERSION,
+ instead of recording the actual SONAME. If the SONAME doesn't
+ match one of the two expected formats
+ (libfoo-VERSION.so or libfoo.so.VERSION), it
+ cannot be represented.
+
@@ -5875,9 +6035,10 @@ Replaces: mail-transport-agent
required by symbols files is not too difficult to
maintain. However, maintaining exhaustive symbols information
for a C++ library can be quite onerous, so shlibs
- files may be more appropriate for most C++ libraries. udebs
- must also use shlibs, since the udeb infrastructure
- does not use symbols.
+ files may be more appropriate for most C++ libraries. Libraries
+ with a corresponding udeb must also provide
+ a shlibs file, since the udeb infrastructure does
+ not use symbols files.
@@ -5894,23 +6055,22 @@ Replaces: mail-transport-agent
the libraries and the symbols in those libraries directly
needed by the binaries or shared libraries in the package.
- dpkg-shlibdeps will use the symbols
- or shlibs files installed by the shared libraries
- to generate dependency information.
-
-
-
- If your package contains any compiled binaries or shared
- libraries, put a call to dpkg-shlibdeps into
+ To do this, put a call to dpkg-shlibdeps into
your debian/rules file in the source package.
List all of the compiled binaries, libraries, or loadable
modules in your package.
- The easiest way to do this is to use a package helper
- framework such as debhelper. If you are
+ The easiest way to call dpkg-shlibdeps
+ correctly is to use a package helper framework such
+ as debhelper. If you are
using debhelper,
the dh_shlibdeps program will do this work for
you. It will also correctly handle multi-binary packages.
+ dpkg-shlibdeps will use the symbols
+ or shlibs files installed by the shared libraries
+ to generate dependency information. The package must then
+ provide a substitution variable into which the discovered
+ dependency information can be placed.
@@ -5928,25 +6088,26 @@ Replaces: mail-transport-agent
- This command puts the dependency information into
- the debian/substvars file, which is then used
- by dpkg-gencontrol. You will need to place
- a ${shlibs:Depends} variable in the Depends
- field in the control file of every binary package built by
- this source package that contains compiled binaries,
- libraries, or loadable modules. If you have multiple binary
- packages, you will need to call dpkg-shlibdeps on
- each one which contains compiled libraries or binaries, using
+ dpkg-shlibdeps puts the dependency information
+ into the debian/substvars file by default, which
+ is then used by dpkg-gencontrol. You will need
+ to place a ${shlibs:Depends} variable in
+ the Depends field in the control file of every binary
+ package built by this source package that contains compiled
+ binaries, libraries, or loadable modules. If you have
+ multiple binary packages, you will need to
+ call dpkg-shlibdeps on each one which contains
+ compiled libraries or binaries. For example, you could use
the -T option to the dpkg utilities to
specify a different substvars file for each
binary package.
Again, dh_shlibdeps
and dh_gencontrol will handle everything except
- the control file modification for you if you're
- using debhelper, including generating
- separate substvars files for each binary
- package and calling dpkg-gencontrol with the
- appropriate flags.
+ the addition of the variable to the control file for you if
+ you're using debhelper, including
+ generating separate substvars files for each
+ binary package and calling dpkg-gencontrol with
+ the appropriate flags.
@@ -5965,8 +6126,8 @@ Replaces: mail-transport-agent
linked indirectly to foo, and the dynamic
linker will load them automatically when it
loads libbar. A package should depend on the
- libraries it directly uses, but not the libraries it
- indirectly uses. The dependencies for the libraries used
+ libraries it directly uses, but not the libraries it only uses
+ indirectly. The dependencies for the libraries used
directly will automatically pull in the indirectly-used
libraries. dpkg-shlibdeps will handle this logic
automatically, but package maintainers need to be aware of
@@ -6010,14 +6171,26 @@ Replaces: mail-transport-agent
There are two types of ABI changes: ones that are
backward-compatible and ones that are not. An ABI change is
- backward-compatible if any binary was linked with the previous
- version of the shared library will still work correctly with
- the new version of the shared library. Adding new symbols to
- the shared library is a backward-compatible change. Removing
- symbols from the shared library is not. Changing the behavior
- of a symbol may or may not be backward-compatible depending on
- the change; for example, changing a function to accept a new
- enum constant not previously used by the library is generally
+ backward-compatible if any reasonable program or library that
+ was linked with the previous version of the shared library
+ will still work correctly with the new version of the shared
+ library.
+ An example of an "unreasonable" program is one that uses
+ library interfaces that are documented as internal and
+ unsupported. If the only programs or libraries affected by
+ a change are "unreasonable" ones, other techniques, such as
+ declaring Breaks relationships with affected
+ packages or treating their usage of the library as bugs in
+ those packages, may be appropriate instead of changing the
+ SONAME. However, the default approach is to change the
+ SONAME for any change to the ABI that could break a program.
+
+ Adding new symbols to the shared library is a
+ backward-compatible change. Removing symbols from the shared
+ library is not. Changing the behavior of a symbol may or may
+ not be backward-compatible depending on the change; for
+ example, changing a function to accept a new enum constant not
+ previously used by the library is generally
backward-compatible, but changing the members of a struct that
is passed into library functions is generally not unless the
library takes special precautions to accept old versions of
@@ -6065,9 +6238,9 @@ Replaces: mail-transport-agent
- A common example of when a change to the is required is a
- function that takes an enum or struct argument that controls
- what the function does. For example:
+ A common example of when a change to the dependency version
+ is required is a function that takes an enum or struct
+ argument that controls what the function does. For example:
enum library_op { OP_FOO, OP_BAR };
int library_do_operation(enum library_op);
@@ -6118,10 +6291,10 @@ Replaces: mail-transport-agent
symbols files for a shared library are normally
- provided by the shared library package, but there are
- several override paths that are checked first in case that
- information is wrong or missing. The following list gives
- them in the order in which they are read
+ provided by the shared library package as a control file,
+ but there are several override paths that are checked first
+ in case that information is wrong or missing. The following
+ list gives them in the order in which they are read
by dpkg-shlibdeps The first one that contains
the required information is used.
@@ -6132,8 +6305,8 @@ Replaces: mail-transport-agent
During the package build, if the package itself
contains shared libraries with symbols
files, they will be generated in these staging
- directories
- by dpkg-gensymbols. symbols
+ directories by dpkg-gensymbols
+ (see [). symbols
files found in the build tree take precedence
over symbols files from other binary
packages.
@@ -6316,8 +6489,9 @@ Replaces: mail-transport-agent
recent version of the shared library that changed the
behavior of that symbol, whether by adding it, changing its
function signature (the parameters, their types, or the
- return type), or its behavior in a way that is visible to a
- caller. id-of-dependency-template is an optional
+ return type), or changing its behavior in a way that is
+ visible to a caller.
+ id-of-dependency-template is an optional
field that references
an alternative-dependency-template; see below for
a full description.
@@ -6338,9 +6512,9 @@ Replaces: mail-transport-agent
compressBound@ZLIB_1.2.0 1:1.2.0
]
Packages using only compress would then get a
- dependency of zlib1g (>= 1:1.1.4), but packages
+ dependency on zlib1g (>= 1:1.1.4), but packages
using compressBound would get a dependency
- of zlib1g (>= 1:1.2.0).
+ on zlib1g (>= 1:1.2.0).
@@ -6625,7 +6799,7 @@ Replaces: mail-transport-agent
library was in version 1:1.2.3.3.dfsg-1, then
the shlibs entry for this library could say:
- libz 1 zlib1g (>= 1:1.2.3.3.dfsg-1)
+ libz 1 zlib1g (>= 1:1.2.3.3.dfsg)
This version restriction must be new enough that any binary
built against the current version of the library will work
@@ -6637,7 +6811,7 @@ Replaces: mail-transport-agent
As zlib1g also provides a udeb containing the shared
library, there would also be a second line:
- udeb: libz 1 zlib1g-udeb (>= 1:1.2.3.3.dfsg-1)
+ udeb: libz 1 zlib1g-udeb (>= 1:1.2.3.3.dfsg)
@@ -10444,6 +10618,10 @@ END-INFO-DIR-ENTRY
README.Debian or some other appropriate place.
+
+ All copyright files must be encoded in UTF-8.
+
+
Machine-readable copyright information
@@ -11070,6 +11248,17 @@ END-INFO-DIR-ENTRY
dpkg-genchanges.
+
+
+ dpkg-shlibdeps - calculates shared library
+ dependencies
+
+
+
+ See .
+
+
+
dpkg-distaddfile - adds a file to