Config::Model::models::Dpkg(3pm)

NAME
Config::Model::models::Dpkg - Configuration class Dpkg

DESCRIPTION
Configuration classes used by Config::Model

Model of Debian source package files (e.g debian/control, debian/copyright...)

Elements

  my_config
This element contains a set of parameters to tune the behavior of this dpkg editor. You can for instance specify e-mail replacements. These parameters are stored in ~/.dpkg-meta.yml or ~/.local/share/.dpkg-meta.yml. These parameters can be applied to all Debian packages you maintain in this unix account. Optional. Type node of class Dpkg::Meta .

  compat
compat file defines the debhelper compatibility level. Optional. Type integer.

  control
Package control file. Specifies the most vital (and version-independent) information about the source package and about the binary packages it creates. Optional. Type node of class Dpkg::Control .

  rules - package build rules
debian/rules is a makefile containing all instructions required to build a debian package. Optional. Type string.

default value :
    #!/usr/bin/make -f # See debhelper(7) (uncomment to enable) # output every command that modifies files on the build system. #DH_VERBOSE = 1

    # see EXAMPLES in dpkg-buildflags(1) and read /usr/share/dpkg/* DPKG_EXPORT_BUILDFLAGS = 1 include /usr/share/dpkg/default.mk

    # see FEATURE AREAS in dpkg-buildflags(1) #export DEB_BUILD_MAINT_OPTIONS = hardening=+all

    # see ENVIRONMENT in dpkg-buildflags(1) # package maintainers to append CFLAGS #export DEB_CFLAGS_MAINT_APPEND = -Wall -pedantic # package maintainers to append LDFLAGS #export DEB_LDFLAGS_MAINT_APPEND = -Wl,--as-needed

    # main packaging script based on dh7 syntax %:
        dh $@

  changelog
Dummy changelog entry with a dummy date. Don't forget to change the version number. Use dch command to update. Optional. Type string.

Note: changelog is computed with

 $pkg_name (0.0.0.0-0) UNRELEASED; urgency=medium

   * ...

  -- $name <$mail>  Wed, 18 Jan 2017 18:28:23 +0100

and with:

•   $mail => "! my_config email"

•   $name => "! my_config fullname"

•   $pkg_name => "! control source Source"

  scan-copyright-patterns
This parameter is used by "cme update dpkg-copyright". This command scans all source files to get copyright and license information. By default, the decision whether to scan a file or not is left to licensecheck. You can override this behavior using this parameter.

See "electing or ignoring files to scan" in Dpkg::Copyright::Scanner for more details. Optional. Type node of class Dpkg::Copyright::ScanPatterns .

  fill-copyright-blanks - Provides missing copyright info for cme update
This parameter is used by "cme update dpkg-copyright command".

Sometimes, upstream coders are not perfect: some source files cannot be parsed correctly or some legal information is missing. A file without copyright and license information is skipped. On the other hand, a file with either copyright or license missing will be used. Unfortunately, this will prevent a correct grouping and merging of copyright entries. Instead of patching upstream source files to fill the blank, you can specify the missing information in a special file. Optional. Type node of class Dpkg::Copyright::FillBlanks .

  fix.scanned.copyright
Instructions to alter or set specific copyright entries in "debian/fix.scanned.copyright" file. Each line of this file follows the syntax described in Config::Model::Loader to modify copyright information.

See "Tweak copyright entries" in Config::Model::Dpkg::Copyright for more details. Optional. Type string.

  copyright - copyright and license information
copyright and license information of all files contained in this package. Optional. Type node of class Dpkg::Copyright .

  install
List the files to install into each package and the directory they should be installed to.

Here's the mapping between the debian install files and the install key:

•   "." -> "debian/install"

•   "package" -> "debian/package.install"

•   "package/arch" -> "debian/package.install.arch"

•   "package.docs" -> "debian/package.docs"

Optional. Type hash of node of class Dpkg::Install .

  examples
List of examples files (or directories) to install into "/usr/share/doc/package/examples"

First, use the package name as the key of the hash.

This hash has a "content" element, which is a list of values. Each value contains a line of "debian/<package>.examples".

The syntax of these line is explained in dh_installexamples(1). Optional. Type hash of node of class Dpkg::Install .

  not-installed
List the files that are deliberately not installed in any binary package. Paths listed in this file are (only) ignored by the check done via --list-missing (or --fail-missing). However, it is not a method to exclude files from being installed. Please use --exclude for that.

Please keep in mind that dh_install will not expand wildcards in this file. Optional. Type list of uniline.

  source
Optional. Type node of class Dpkg::Source .

  lintian-overrides
Contains the lintian overrides parameters from all lintian overrides files contained in "debian/*lintian-overrides".

plain "lintian-overrides" file is contained in "." element.

Other files are contained in basename element.

For instance, "debian/foo.lintian-overrides" is contained in "foo" element.

Likewise, override for source package is contained in "source" element.

For more detail, see lintian doc <https://lintian.debian.org/manual/index.html#overrides>

Unknown lintian tags trigger a warning.

Optional. Type hash of string.

  clean - list of files to clean
list of files to remove when dh_clean is run. Files names can include wild cards. For instance:

 build.log
 Makefile.in
 */Makefile.in
 */*/Makefile.in

Optional. Type list of uniline.

  bugfiles
Optional. Type hash of node of class Dpkg::BugFiles .

  package-scripts
Optional. Type hash of node of class Dpkg::PackageScripts .

  patches - Debian patches applied to original sources
Series of patches applied by Debian. Note that you cannot change the order of patches in the series. Use quilt for this task. Comments in series file are skipped and not shown in annotation. Optional. Type hash of node of class Dpkg::Patch .

  dirs - Extra directories
This file specifies any directories which we need but which are not created by the normal installation procedure (make install DESTDIR=... invoked by dh_auto_install). This generally means there is a problem with the Makefile.

Files listed in an install file don't need their directories created first.

It is best to try to run the installation first and only use this if you run into trouble. There is no preceding slash on the directory names listed in the dirs file. Optional. Type list of uniline.

  docs
This file specifies the file names of documentation files we can have dh_installdocs(1) install into the temporary directory for us.

By default, it will include all existing files in the top-level source directory that are called BUGS, README*, TODO etc. Optional. Type list of uniline.

  watch
watch file used by uscan to monitor upstream sources. Optional. Type string.

  tests
Debian CI test suite specification. See README.package-tests.rst <https://salsa.debian.org/ci-team/autopkgtest/blob/master/doc/README.package-tests.rst> for more details. Optional. Type warped_node of class Dpkg::Tests .

  upstream-metadata - Upstream Metadata Specification
The upstream metadata file is meant to contain machine-readable metadata about the upstream project, its community and processes.

Information in this file should not be specific to Debian, and be relevant for other distributions as well.

Optional. Type node of class Dpkg::Upstream::Metadata .

SEE ALSO

•   cme

•   Config::Model::models::Dpkg::BugFiles

•   Config::Model::models::Dpkg::Control

•   Config::Model::models::Dpkg::Copyright

•   Config::Model::models::Dpkg::Copyright::FillBlanks

•   Config::Model::models::Dpkg::Copyright::ScanPatterns

•   Config::Model::models::Dpkg::Install

•   Config::Model::models::Dpkg::Meta

•   Config::Model::models::Dpkg::PackageScripts

•   Config::Model::models::Dpkg::Patch

•   Config::Model::models::Dpkg::Source

•   Config::Model::models::Dpkg::Tests

•   Config::Model::models::Dpkg::Upstream::Metadata

AUTHOR

Dominique Dumont

COPYRIGHT
2010-2015 Dominique Dumont

LICENSE

LGPL2