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

NAME
Config::Model::Dpkg::Copyright - Fill the File sections of debian/copyright file

SYNOPSIS
 # this modules is used by cme when invoked with this command
 $ cme update dpkg-copyright

DESCRIPTION
This commands helps with the tedious task of maintening "debian/copyright" file. When you package a new release of a software, you can run "cme update dpkg-copyright" to update the content of the copyright file.

This command scans current package directory to extract copyright and license information and store them in the Files sections of debian/copyright file.

In debian package directory:

* run 'cme update dpkg-copyright' or 'cme update dpkg' * check the result with your favorite VCS diff tool. (you do use
  a VCS for your package files, do you ?)

Note: this command is experimental.

Debian copyright data
The "Files: debian/*" section from "debian/copyright" is often the only place containing copyright information for the files created by Debian maintainer. So all "Files" entries beginning with "debian/" are preserved during update. However, entries not matching an existing file or directory are removed.

Tweak results
Results can be tweaked either by:

•   Changing the list of files to scan or ignore. (By default, licensecheck will decide which file to scan or not.)

•   Specifying information for individual files

•   Tweaking the copyright entries created by grouping and coaslescing information.

The first 2 ways are described in "Selecting or ignoring files to scan" in Dpkg::Copyright::Scanner and "Filling the blanks" in Dpkg::Copyright::Scanner.

The last way is described below:

  Tweak copyright entries
Since the extraction of copyright information from source file is based on comments, the result is sometimes lackluster. Your may specify instruction to alter or set specific copyright entries in "debian/fix.scanned.copyright" file (or "debian/<source-package>.fix.scanned.copyright").

cme stores the copyright information in a tree. Entries in "fix.scanned.copyright" provide instructions for traversing the cme tree and modifying entries. You can have a view of "debian/copyright" file translated in this syntax by running "cme dump --format cml dpkg-copyright". Each line of this file will be handled by Config::Model::Loader to modify copyright information; the full syntax is documented in "load string syntax" in Config::Model::Loader section.

  Example
If the extracted copyright contains:

 Files: *
 Copyright: 2014-2015, Adam Kennedy <adamk@cpan.org> "foobar
 License: Artistic or GPL-1+

You may add this line in "debian/fix.scanned.copyright" file:

 ! Files:"*" Copyright=~s/\s*".*//

This way, the copyright information will be updated from the file content but the extra ""foobar" will always be removed during updates.

Comments are accepted in Perl and C++ style from the beginning of the line. Lines breaks are ignored.

Here's another more complex example:

 // added a global license, MIT license text is filled by Config::Model
 ! copyright License:MIT

 # don't forget '!' to go back to tree root
 ! copyright Files:"pan/general/map-vector.h" Copyright="2001,Andrei Alexandrescu"
   License short_name=MIT
 # delete license text since short_name points to global  MIT license
   full_license~

 # use a loop there vvvvvv to clean up that vvvvvvvvvvvvvvvvvvvvvvv in all copyrights
 ! copyright   Files:~/.*/     Copyright=~s/all\s*rights\s*reserved//i

 # defeat spammer by replacing all '@' in emails of 3rdparty files
 # the operation :~/^3party/ loops over all Files entries that match ^3rdparty
 # and modify the copyright entry with a Perl substitution
 ! Files:~/^3rdparty/ Copyright=~s/@/(at)/

Sometimes, you might want to find an entry that spans multiple lines. You can do this by double quoting the whole value:

 ! Files:"uulib/crc32.h
 uulib/uustring.h" Copyright="2019 John Doe"

Under the hood
This section explains how cme merges the information from the existing "debian/copyright" file (the "old" information) with the information extracted by licensecheck (the "new" information):

•   The old and new information are compared in the form of file lists:

    •   New file entries are kept as is in the new list.

    •   When a file entry is found in both old and new lists, the new © and license short names are checked. If they are unknown, the information from the old list is copied in the new list.

    •   Old files entries not found in the new list are deleted.

•   File entries are coalesced in the new list to reduce redundancies (this mechanism is explained in this blog <https://ddumont.wordpress.com/2015/04/05/improving-creation-of-debian-copyright-file>)

•   License entries are created, either attached to Files specification or as global licenses. License text is added for known license (actually known by Software::License)

•   Directories (path ending with "/*") from old list then checked:

    •   Directory is found in the new list: the old information is clobbered by new information.

    •   Directory not found in new list but exists: the old information is copied in the new list.

    •   Directory is not found: the old information is discarded

•   Files entries are sorted and the new "debian/copyright" is generated.

update
Updates data using the output "scan_files"" in Dpkg::Copyright::Scanner.

Parameters in %args:

quiet
    set to 1 to suppress progress messages. Should be used only in tests.

Otherwise, %args is passed to "scan_files"

AUTHOR
Dominique Dumont <dod@debian.org>