Config::Model::models::Dpkg::Control::Source (3)

Leading comments

Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/Config::Model::models::Dpkg::Control::Source.3pm".)

NAME

Config::Model::models::Dpkg::Control::Source - Configuration class Dpkg::Control::Source

DESCRIPTION

Configuration classes used by Config::Model

Elements

Source - source package name

Source package name. Defaults to the name of the current directory. Mandatory. Type uniline.

Note: Source is computed with '"$ENV{PWD} =~ m!/([^/]+)$!; $1;"' and with:

*

Maintainer - package maintainer's name and email address

The package maintainer's name and email address. The name must come first, then the email address inside angle brackets <> (in format).

If the maintainer's name contains a full stop then the whole field will not work directly as an email address due to a misfeature in the syntax specified in

; a program using this field as an address must check for this and correct the problem if necessary (for example by putting the name in round brackets and moving it to the end, and bringing the email address forward). Mandatory. Type uniline.

Note: Maintainer is computed with

 my $name = $ENV{DEBFULLNAME};
 my $email = $ENV{DEBEMAIL} ;
 my $ret;
 $ret = "$name <$email>" if defined $name and defined $email;
 $ret;

and with:

*

Uploaders

Optional. Type list of uniline.

Section

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

The archive area and section for each package should be specified in the package's Section control record (see Section 5.6.5 <www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Section>). 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 archive area,

*

area/section if the package is in the contrib or non-free archive areas.

Optional. Type uniline.

default value :

misc

XS-Testsuite - name of the non regression test suite

Enable a test suite to be used with this package. For more details see .package-tests.rst <anonscm.debian.org/cgit/autopkgtest/autopkgtest.git/plain/doc/README.package-tests.rst> Deprecated Optional. Type uniline.

Testsuite - name of the non regression test suite

Enable a test suite to be used with this package. For more details see .package-tests.rst <anonscm.debian.org/cgit/autopkgtest/autopkgtest.git/plain/doc/README.package-tests.rst> Optional. Type uniline.

Note: Testsuite is migrated with '$xs_testsuite' and with:

*

$xs_testsuite => "- XS-Testsuite"

XS-Autobuild - Allow automatic build of non-free or contrib package

Read the full description from section 5.10.5 <www.debian.org/doc/manuals/developers-reference/pkgs.html#non-free-buildd> in Debian developer reference. Optional. Type boolean.

default value :

0

Priority

Optional. Type enum. choice: 'required', 'important', 'standard', 'optional', 'extra'.

default value :

optional

Here are some explanations on the possible values:

'extra'

This contains all packages that conflict with others 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 (such as packages containing only detached debugging symbols).

'important'

Important programs, including those which one would expect to find on any Unix-like system. If the expectation is that an experienced Unix person who found it missing would say ``What on earth is going on, where is foo?'', it must be an important package.[5] Other packages without which the system will not run well or be usable must also have priority important. This does not include Emacs, the X Window System, TeX or any other large applications. The important packages are just a bare minimum of commonly-expected and necessary tools.

'optional'

(In a sense everything that isn't required is optional, but that's not what is meant here.) This is all the software that you might reasonably want to install if you didn't know what it was and don't have specialized requirements. This is a much larger system and includes the X Window System, a full TeX distribution, and many applications. Note that optional packages should not conflict with each other.

'required'

Packages which are necessary for the proper functioning of the system (usually, this means that dpkg functionality depends on these packages). Removing a required package may cause your system to become totally broken and you may not even be able to use dpkg to put things back, so only do so if you know what you are doing. Systems with only the required packages are probably unusable, but they do have enough functionality to allow the sysadmin to boot and install more software.

'standard'

These packages provide a reasonably small but not too limited character-mode system. This is what will be installed by default if the user doesn't select anything else. It doesn't include many large applications.

Build-Depends - List of package required during clean or build of architecture-dependent packages

List of packages that must be installed:

*

during clean

*

to build architecture-dependent binaries (``Architecture: any'' or specific architectures).

Technically, these packages must be installed for the following build targets: clean, build-arch, and binary-arch. See build target <www.debian.org/doc/debian-policy/ch-source.html#s-debianrules> doc and details on this field <www.debian.org/doc/debian-policy/ch-relationships.html#s-sourcebinarydeps>.

On the other hand, the list of packages that must be installed to build architecture-independent binaries (``Architecture: all'') should be listed in ``Build-Depends-Indep'' field.

Including a dependency in this field does not have the exact same effect as including it in both Build-Depends-Arch and Build-Depends-Indep, because the dependency also needs to be satisfied when building the source package.

See also deb-src-control <manpages.debian.org/unstable/dpkg-dev/deb-src-control.5.en.html> man page. Optional. Type list of uniline.

Build-Depends-Arch - List of package required to build architecture-dependent packages

Same as Build-Depends, but these pakcages are only needed when building the architecture dependent packages. The Build-Depends are also installed in this case.

See deb-src-control man page <manpages.debian.org/unstable/dpkg-dev/deb-src-control.5.en.html> for details. Optional. Type list of uniline.

Build-Depends-Indep - List of package required during build of architecture-independent package

List of packages that must be installed to build architecture-independent binaries (``Architecture: all'').

Technically, these packages must be installed for the following build targets: build, build-indep, binary, and binary-indep. See build target <www.debian.org/doc/debian-policy/ch-source.html#s-debianrules> doc and details on this field <www.debian.org/doc/debian-policy/ch-relationships.html#s-sourcebinarydeps>.

Note that packages required during ``clean'' phase must be declared in ``Build-Depends'' field. Optional. Type list of uniline.

Build-Conflicts - List of package not wanted during clean or build of architecture-dependent packages

List of packages that must be missing (i.e. not installed):

*

during clean

*

to build architecture-dependent binaries (``Architecture: any'' or specific architectures).

Technically, these packages must not be installed for the following build targets: clean, build-arch, and binary-arch. See build target <www.debian.org/doc/debian-policy/ch-source.html#s-debianrules> doc and details on this field <www.debian.org/doc/debian-policy/ch-relationships.html#s-sourcebinarydeps>.

On the other hand, the list of packages that must not be installed to build architecture-independent binaries (``Architecture: all'') should be listed in ``Build-Conflicts-Indep'' field.

Including a dependency in this list has the same effect as including it in both Build-Conflicts-Arch and Build-Conflicts-Indep, with the additional effect of being used for source-only builds.

See deb-src-control man page <manpages.debian.org/unstable/dpkg-dev/deb-src-control.5.en.html> for details. Optional. Type list of uniline.

Build-Conflicts-Arch - List of package not wanted during build of architecture dependent packages

List of packages that must be missing (i.e. not installed) to build archictecture dependent binaries

See deb-src-control man page <manpages.debian.org/unstable/dpkg-dev/deb-src-control.5.en.html> for details. Optional. Type list of uniline.

Build-Conflicts-Indep - List of package not wanted during build of architecture-independent packages

List of packages that must be missing (i.e. not installed) to build binaries with arch set to "all.

Technically, these packages must not be installed for the following build targets: build, build-indep, binary, and binary-indep. See build target <www.debian.org/doc/debian-policy/ch-source.html#s-debianrules> doc and details on this field <www.debian.org/doc/debian-policy/ch-relationships.html#s-sourcebinarydeps>.

Note that packages not wanted during ``clean'' phase must be declared in ``Build-Conflicts'' field. Optional. Type list of uniline.

Built-Using - Additional source packages used to build the binary

 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, including an exactly equal (``='') version relation on the version that was used to build that binary package[57].

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)
I< Optional. Type list of uniline.  >

Standards-Version - Debian policy version number this package complies to

This field indicates the Debian policy version number this package complies to.

Before updating this field, please read upgrading-checklist <www.debian.org/doc/debian-policy/upgrading-checklist.html> to know what changes came with a new policy version number and apply the required changes (if any) to your package. Optional. Type uniline.

default value :

4.1.0

Vcs-Browser - web-browsable

URL

of the

VCS

repository

Value of this field should be a http:// pointing to a web-browsable copy of the Version Control System repository used to maintain the given package, if available.

The information is meant to be useful for the final user, willing to browse the latest work done on the package (e.g. when looking for the patch fixing a bug tagged as pending in the bug tracking system). Optional. Type uniline.

Note: Vcs-Browser is computed with

   $maintainer =~ /(pkg-perl)/                       ? "anonscm.debian.org/cgit/$1/packages/$pkgname.git"
 : $maintainer =~ /(pkg-(?:ruby-extras|javascript))/ ? "anonscm.debian.org/cgit/$1/$pkgname.git"
 :                                                     undef ;

and with:

*

$maintainer => "- Maintainer"

*

$pkgname => "- Source"

Vcs-Arch -

URL

of the

VCS

repository

Value of this field should be a string identifying unequivocally the location of the Version Control System repository used to maintain the given package, if available. * identify the Version Control System; currently the following systems are supported by the package tracking system: arch, bzr (Bazaar), cvs, darcs, git, hg (Mercurial), mtn (Monotone), svn (Subversion). It is allowed to specify different fields for the same package: they will all be shown in the web interface.

The information is meant to be useful for a user knowledgeable in the given Version Control System and willing to build the current version of a package from the

sources. Other uses of this information might include automatic building of the latest version of the given package. To this end the location pointed to by the field should better be version agnostic and point to the main branch (for VCSs supporting such a concept). Also, the location pointed to should be accessible to the final user; fulfilling this requirement might imply pointing to an anonymous access of the repository instead of pointing to an SSH-accessible version of the same. Optional. Type uniline.

Vcs-Bzr -

URL

of the

VCS

repository

Value of this field should be a string identifying unequivocally the location of the Version Control System repository used to maintain the given package, if available. * identify the Version Control System; currently the following systems are supported by the package tracking system: arch, bzr (Bazaar), cvs, darcs, git, hg (Mercurial), mtn (Monotone), svn (Subversion). It is allowed to specify different fields for the same package: they will all be shown in the web interface.

The information is meant to be useful for a user knowledgeable in the given Version Control System and willing to build the current version of a package from the

sources. Other uses of this information might include automatic building of the latest version of the given package. To this end the location pointed to by the field should better be version agnostic and point to the main branch (for VCSs supporting such a concept). Also, the location pointed to should be accessible to the final user; fulfilling this requirement might imply pointing to an anonymous access of the repository instead of pointing to an SSH-accessible version of the same. Optional. Type uniline.

Vcs-Cvs -

URL

of the

VCS

repository

Value of this field should be a string identifying unequivocally the location of the Version Control System repository used to maintain the given package, if available. * identify the Version Control System; currently the following systems are supported by the package tracking system: arch, bzr (Bazaar), cvs, darcs, git, hg (Mercurial), mtn (Monotone), svn (Subversion). It is allowed to specify different fields for the same package: they will all be shown in the web interface.

The information is meant to be useful for a user knowledgeable in the given Version Control System and willing to build the current version of a package from the

sources. Other uses of this information might include automatic building of the latest version of the given package. To this end the location pointed to by the field should better be version agnostic and point to the main branch (for VCSs supporting such a concept). Also, the location pointed to should be accessible to the final user; fulfilling this requirement might imply pointing to an anonymous access of the repository instead of pointing to an SSH-accessible version of the same. Optional. Type uniline.

Vcs-Darcs -

URL

of the

VCS

repository

Value of this field should be a string identifying unequivocally the location of the Version Control System repository used to maintain the given package, if available. * identify the Version Control System; currently the following systems are supported by the package tracking system: arch, bzr (Bazaar), cvs, darcs, git, hg (Mercurial), mtn (Monotone), svn (Subversion). It is allowed to specify different fields for the same package: they will all be shown in the web interface.

The information is meant to be useful for a user knowledgeable in the given Version Control System and willing to build the current version of a package from the

sources. Other uses of this information might include automatic building of the latest version of the given package. To this end the location pointed to by the field should better be version agnostic and point to the main branch (for VCSs supporting such a concept). Also, the location pointed to should be accessible to the final user; fulfilling this requirement might imply pointing to an anonymous access of the repository instead of pointing to an SSH-accessible version of the same. Optional. Type uniline.

Vcs-Git -

URL

of the

VCS

repository

Value of this field should be a string identifying unequivocally the location of the Version Control System repository used to maintain the given package, if available. * identify the Version Control System; currently the following systems are supported by the package tracking system: arch, bzr (Bazaar), cvs, darcs, git, hg (Mercurial), mtn (Monotone), svn (Subversion). It is allowed to specify different fields for the same package: they will all be shown in the web interface.

The information is meant to be useful for a user knowledgeable in the given Version Control System and willing to build the current version of a package from the

sources. Other uses of this information might include automatic building of the latest version of the given package. To this end the location pointed to by the field should better be version agnostic and point to the main branch (for VCSs supporting such a concept). Also, the location pointed to should be accessible to the final user; fulfilling this requirement might imply pointing to an anonymous access of the repository instead of pointing to an SSH-accessible version of the same. Optional. Type uniline.

Note: Vcs-Git is computed with

   $maintainer =~ /(pkg-perl)/                        ? "anonscm.debian.org/git/$1/packages/$pkgname.git"
 : $maintainer =~ /(pkg-(?:ruby-extras|javascript))/  ? "anonscm.debian.org/git/$1/$pkgname.git"
 :                                                    '' ;

and with:

*

$maintainer => "- Maintainer"

*

$pkgname => "- Source"

Vcs-Hg -

URL

of the

VCS

repository

Value of this field should be a string identifying unequivocally the location of the Version Control System repository used to maintain the given package, if available. * identify the Version Control System; currently the following systems are supported by the package tracking system: arch, bzr (Bazaar), cvs, darcs, git, hg (Mercurial), mtn (Monotone), svn (Subversion). It is allowed to specify different fields for the same package: they will all be shown in the web interface.

The information is meant to be useful for a user knowledgeable in the given Version Control System and willing to build the current version of a package from the

sources. Other uses of this information might include automatic building of the latest version of the given package. To this end the location pointed to by the field should better be version agnostic and point to the main branch (for VCSs supporting such a concept). Also, the location pointed to should be accessible to the final user; fulfilling this requirement might imply pointing to an anonymous access of the repository instead of pointing to an SSH-accessible version of the same. Optional. Type uniline.

Vcs-Mtn -

URL

of the

VCS

repository

Value of this field should be a string identifying unequivocally the location of the Version Control System repository used to maintain the given package, if available. * identify the Version Control System; currently the following systems are supported by the package tracking system: arch, bzr (Bazaar), cvs, darcs, git, hg (Mercurial), mtn (Monotone), svn (Subversion). It is allowed to specify different fields for the same package: they will all be shown in the web interface.

The information is meant to be useful for a user knowledgeable in the given Version Control System and willing to build the current version of a package from the

sources. Other uses of this information might include automatic building of the latest version of the given package. To this end the location pointed to by the field should better be version agnostic and point to the main branch (for VCSs supporting such a concept). Also, the location pointed to should be accessible to the final user; fulfilling this requirement might imply pointing to an anonymous access of the repository instead of pointing to an SSH-accessible version of the same. Optional. Type uniline.

Vcs-Svn -

URL

of the

VCS

repository

Value of this field should be a string identifying unequivocally the location of the Version Control System repository used to maintain the given package, if available. * identify the Version Control System; currently the following systems are supported by the package tracking system: arch, bzr (Bazaar), cvs, darcs, git, hg (Mercurial), mtn (Monotone), svn (Subversion). It is allowed to specify different fields for the same package: they will all be shown in the web interface.

The information is meant to be useful for a user knowledgeable in the given Version Control System and willing to build the current version of a package from the

sources. Other uses of this information might include automatic building of the latest version of the given package. To this end the location pointed to by the field should better be version agnostic and point to the main branch (for VCSs supporting such a concept). Also, the location pointed to should be accessible to the final user; fulfilling this requirement might imply pointing to an anonymous access of the repository instead of pointing to an SSH-accessible version of the same. Optional. Type uniline.

DM-Upload-Allowed - The package may be uploaded by a Debian Maintainer

If this field is present, then any Debian Maintainers listed in the Maintainer or Uploaders fields may upload the package directly to the Debian archive. For more information see the ``Debian Maintainer'' page at the Debian Wiki - wiki.debian.org/DebianMaintainer Deprecated Optional. Type uniline.

Homepage

Optional. Type uniline.

XS-Python-Version

Deprecated Optional. Type uniline.

X-Python-Version - supported versions of Python

This field specifies the versions of Python (not versions of Python 3) supported by the source package. When not specified, they default to all currently supported Python (or Python 3) versions. For more detail, See python policy <www.debian.org/doc/packaging-manuals/python-policy/ch-module_packages.html#s-specifying_versions> Optional. Type uniline.

upstream_default value :

all

Note: X-Python-Version is migrated with

 my $old = $xspython ;
 my $new ;
 if ($old =~ /,/) {
    # list of versions
    my @list = sort split /\s*,\s*/, $old ; 
    $new = ">= ". (shift @list) . ", << " .  (pop @list) ;
 }
 elsif ($old =~ /-/) {
    my @list = sort grep { $_ ;} split /\s*-\s*/, $old ; 
    $new = ">= ". shift @list ;
    $new .= ", << ". pop @list if @list ;
 }
 else {
    $new = $old ;
 }
 $new ;

and with:

*

$xspython => "- XS-Python-Version"

X-Python3-Version - supported versions of Python3

This field specifies the versions of Python 3 supported by the package. For more detail, See python policy <www.debian.org/doc/packaging-manuals/python-policy/ch-module_packages.html#s-specifying_versions> Optional. Type uniline.

XS-Ruby-Versions

indicate the versions of the interpreter supported by the library. Optional. Type uniline.

SEE ALSO

*

cme

AUTHOR

Dominique Dumont

COPYRIGHT

2010,2011 Dominique Dumont

LICENSE

LGPL2