oracular (3) Config::Model::models::Dpkg::Copyright.3pm.gz

Provided by: libconfig-model-dpkg-perl_3.005_all bug

NAME

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

DESCRIPTION

       Configuration classes used by Config::Model

       Machine-readable debian/copyright. Parameters from former version of DEP-5 are flagged as deprecated. The
       idea is to enable migration from older specs to CANDIDATE spec.

       To edit a copyright file, go into your package development directory and run:

         cme edit dpkg-copyright

       To check you file run:

         cme check dpkg-copyright

       To upgrade your file from an old spec, run:

         cme migrate dpkg-copyright

Elements

   Format
       URI of the format specification.  Mandatory. Type uniline.

       default value :
           https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/

   Upstream-Name
       The name upstream uses for the software.  Optional. Type uniline.

       Note: Upstream-Name is migrated with '$name' and with:

       •   $name => "- Name"

   Upstream-Contact
       The preferred address(es) to reach the upstream project. May be free-form text, but by convention will
       usually be written as a list of RFC5822 addresses or URIs.  Optional. Type list of uniline.

       Note: Upstream-Contact values are migrated from '- Upstream-Maintainer'

   Source
       An explanation from where the upstream source came from. Typically this would be a URL, but it might be a
       free-form explanation. The Debian Policy, 12.5 requires this information unless there are no upstream
       sources, which is mainly the case for native Debian packages. If the upstream source has been modified to
       remove non-free parts, that should be explained in this field.  Optional. Type string.

       Note: Source is migrated with '"$old || $older ;"' and with:

       •   $old => "- Upstream-Source"

       •   $older => "- Original-Source-Location"

   Disclaimer
       This field can be used in the case of non-free and contrib packages (see [Policy 12.5](
       http://www.debian.org/doc/debian-policy/ch-docs.html#s-copyrightfile))  Optional. Type string.

   Comment
       This field can provide additional information. For example, it might quote an e-mail from upstream
       justifying why the license is acceptable to the main archive, or an explanation of how this version of
       the package has been forked from a version known to be DFSG-free, even though the current upstream
       version is not.  Optional. Type string.

       Note: Comment is migrated with '$old' and with:

       •   $old => "- X-Comment"

   Copyright
       Copyright information for the package as a whole, which may be different or simplified from a combination
       of all the per-file copyright information. See also Copyright below in the Files paragraph section.
       Optional. Type string.

   Files
       Patterns indicating files having the same license and sharing copyright holders.  See files pattern
       documentation <https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/#files-field> for
       details.  Optional. Type hash of node of class Dpkg::Copyright::Content .

   Files-Excluded
       White space separated list of file patterns to exclude from the package. This field is only used by
       uscan. Example: "*/Makefile.in aclocal.m4". See also UscanEnhancements
       <https://wiki.debian.org/UscanEnhancements> and the files pattern documentation
       <https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/#files-field>.  Optional. Type string.

   Global-License
        Optional. Type node of class Dpkg::Copyright::GlobalLicense .

   Format-Specification
       Deprecated  Optional. Type uniline.

   Name
       Deprecated  Optional. Type uniline.

   Maintainer
       Line(s) containing the preferred address(es) to reach current upstream maintainer(s). May be free-form
       text, but by convention will usually be written as a list of RFC2822 addresses or URIs. Deprecated
       Optional. Type list of uniline.

   Upstream-Maintainer
       Deprecated  Optional. Type list of uniline.

       Note: Upstream-Maintainer values are migrated from '- Maintainer'

   Upstream-Source
       Deprecated  Optional. Type string.

   Original-Source-Location
       Deprecated  Optional. Type string.

   License
        Optional. Type hash of node of class Dpkg::Copyright::LicenseSpec .

   X-Comment
       Deprecated  Optional. Type string.

SEE ALSO

       •   cme

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

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

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

AUTHOR

       Dominique Dumont

       2010,2011 Dominique Dumont

LICENSE

       LGPL2