Differences between revisions 1 and 5 (spanning 4 versions)
Revision 1 as of 2016-06-14 11:12:40
Size: 832
Editor: wookey
Comment:
Revision 5 as of 2016-06-29 07:05:47
Size: 2223
Editor: PaulWise
Comment: update for licensecheck split-out
Deletions are marked like this. Additions are marked like this.
Line 7: Line 7:
scan-copyrights can update an existing copyright file from rescanning the source. It can also create one from scratch. It uses the underlying licensecheck tool from devscripts `licensecheck` from DebianPackage:licensecheck (and older versions of DebianPackage:devscripts) can scan source code and report found copyright holders and known licenses.
Line 9: Line 9:
The package needed is cme (and libconfig-model-dpkg-perl v2.074 or later) `scan-copyrights` from DebianPackage:libconfig-model-dpkg-perl can update an existing copyright file from rescanning the source. It can also create one from scratch. It uses `licensecheck`.
Line 11: Line 11:
updating is as simple as: Config::Model can update Debian copyright files using the `cme` command (from DebianPackage:cme or DebianPackage:libconfig-model-dpkg-perl less than 2.063):

{{{
Line 13: Line 15:
}}}
Line 14: Line 17:
More details here:
https://github.com/dod38fr/config-model/wiki/Updating-debian-copyright-file-with-cme
A script from DebianPackage:cdbs can generate a copyright file using `licensecheck`:

{{{
licensecheck --copyright -r `find * -type f` | \
  /usr/lib/cdbs/licensecheck2dep5 > debian/copyright.auto
}}}

`license-reconcile` compares the existing copyright with the source code and reports discrepancies.

`debmake -k` also compares the existing copyright with the source code and reports discrepancies.

`debmake -cc` generates a new copyright file from the source code.

`licensee` from DebianPackage:ruby-licensee checks LICENSE files and returns known license names.

[[https://www.fossology.org/|FOSSology]] is a open source license compliance software system and toolkit that [[https://debconf16.debconf.org/talks/100/|can]] (in version 3.1) generate DEP5 copyright files.

Some of the above are run by `check-all-the-things -f copyright`.

= See also =

 * [[https://github.com/dod38fr/config-model/wiki/Updating-debian-copyright-file-with-cme|Updating debian copyright file with cme]] by Dominique Dumont
 * [[http://people.skolelinux.org/pere/blog/Creating__updating_and_checking_debian_copyright_semi_automatically.html|Creating, updating and checking debian/copyright semi-automatically]] by Petter Reinholdtsen

Reviewing upstream packages to write debian/copyright files is tedious manual work. It tends not to get done again after initial packaging, especially not on every release (when something may have changed).

Making initial copyright file construction, and subsequent review/update easier will improve Debian's software quality.

Stretch (Debian 9) has significantly improved tools over previous releases.

licensecheck from licensecheck (and older versions of devscripts) can scan source code and report found copyright holders and known licenses.

scan-copyrights from libconfig-model-dpkg-perl can update an existing copyright file from rescanning the source. It can also create one from scratch. It uses licensecheck.

Config::Model can update Debian copyright files using the cme command (from cme or libconfig-model-dpkg-perl less than 2.063):

cme update dpkg-copyright

A script from cdbs can generate a copyright file using licensecheck:

licensecheck --copyright -r `find * -type f` | \
  /usr/lib/cdbs/licensecheck2dep5 > debian/copyright.auto

license-reconcile compares the existing copyright with the source code and reports discrepancies.

debmake -k also compares the existing copyright with the source code and reports discrepancies.

debmake -cc generates a new copyright file from the source code.

licensee from ruby-licensee checks LICENSE files and returns known license names.

FOSSology is a open source license compliance software system and toolkit that can (in version 3.1) generate DEP5 copyright files.

Some of the above are run by check-all-the-things -f copyright.

See also