checks/source-copyright.desc

   1 Check-Script: source-copyright
   2 Author: Jakub Wilk <jwilk@debian.org>
   3 Abbrev: scpy
   4 Type: source
   5 Needs-Info: debfiles, index
   6 Info: This script checks if a source package conforms to policy
   7  with regard to copyright files.
   8  .
   9  Each source package should have a debian/copyright file.
  10
  11 Tag: debian-copyright-is-symlink
  12 Severity: normal
  13 Certainty: certain
  14 Info: The file <tt>debian/copyright</tt> is a symlink instead of a regular
  15  file.  This makes package checking and manipulation more difficult.
  16  .
  17  This problem may have prevented lintian from performing other checks.
  18
  19 Tag: no-debian-copyright
  20 Severity: minor
  21 Certainty: certain
  22 Ref: policy 12.5
  23 Info: Every package must include the file <tt>/usr/share/doc/<i>pkg</i>/copyright</tt>.
  24  A copy of this file should be in <tt>debian/copyright</tt> in the source package.
  25
  26 Tag: unknown-copyright-format-uri
  27 Severity: pedantic
  28 Certainty: wild-guess
  29 Info: The copyright file appears to intended as machine-readable, but lintian
  30  cannot recognize its format URI.  It could be a typo for a common URI or a
  31  syntax error in the first paragraph.  Please file a bug against Lintian if you
  32  believe that the copyright file in syntactically valid and the URI is
  33  correct.
  34
  35 Tag: boilerplate-copyright-format-uri
  36 Severity: normal
  37 Certainty: possible
  38 Info: Format URI of the machine-readable copyright file contains
  39  <tt>VERSIONED_FORMAT_URL</tt> or <tt>REVISION</tt> string.  Please replace it
  40  with an actual URI or an actual revision number respectively.
  41
  42 Tag: wiki-copyright-format-uri
  43 Severity: pedantic
  44 Certainty: possible
  45 Ref: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
  46 Info: Format URI of the machine-readable copyright file refers to Debian Wiki.
  47  .
  48  Debian Wiki is not used for the format development anymore.  Please use
  49  <tt>http://www.debian.org/doc/packaging-manuals/copyright-format/<i>version</i>/</tt>
  50  as the format URI instead.
  51
  52 Tag: unversioned-copyright-format-uri
  53 Severity: pedantic
  54 Certainty: possible
  55 Ref: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
  56 Info: Format URI of the machine-readable copyright file is not versioned.
  57  .
  58  Please use
  59  <tt>http://www.debian.org/doc/packaging-manuals/copyright-format/<i>version</i>/</tt>
  60  as the format URI instead.
  61
  62 Tag: out-of-date-copyright-format-uri
  63 Severity: pedantic
  64 Certainty: possible
  65 Ref: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
  66 Info: A newer version of the machine-readable copyright file specification,
  67  than the one referenced by the copyright file, is available.
  68  .
  69  This problem may have prevented lintian from performing other checks.
  70
  71 Tag: syntax-error-in-dep5-copyright
  72 Severity: normal
  73 Certainty: possible
  74 Ref: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
  75 Info: The machine-readable copyright file didn't pass Debian control file
  76  syntax check.
  77  .
  78  This issue may hide other issues as Lintian skips some checks on the
  79  file in this case.
  80
  81 Tag: obsolete-field-in-dep5-copyright
  82 Severity: normal
  83 Certainty: possible
  84 Ref: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
  85 Info: The machine-readable copyright file uses a field, that used to be defined
  86  by the specification, but has been renamed since then.
  87  .
  88  Please use Format instead of Format-Specification.
  89  .
  90  Please use Upstream-Contact instead of Contact, Maintainer or Upstream-Maintainer.
  91  .
  92  Please use Upstream-Name instead of Name.
  93
  94 Tag: comma-separated-files-in-dep5-copyright
  95 Severity: normal
  96 Certainty: possible
  97 Ref: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
  98 Info: A list of files in the machine-readable copyright format appears to be
  99  separated by commas.  The file list should be whitespace separated instead.
 100  .
 101  Please note this tag is only emitted once per checked copyright file.
 102
 103 Tag: missing-field-in-dep5-copyright
 104 Severity: normal
 105 Certainty: possible
 106 Ref: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
 107 Info: The paragraph in the machine readable copyright file is missing a field
 108  that is required by the specification.
 109
 110 Tag: missing-license-paragraph-in-dep5-copyright
 111 Severity: normal
 112 Certainty: possible
 113 Ref: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
 114 Info: The files paragraph in the machine readable copyright file references a
 115  license, for which no standalone license paragraph exists.
 116
 117 Tag: missing-license-text-in-dep5-copyright
 118 Severity: normal
 119 Certainty: possible
 120 Ref: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
 121 Info: The standalone license header contains only short license name, but not
 122  the license text.
 123
 124 Tag: unused-license-paragraph-in-dep5-copyright
 125 Severity: minor
 126 Certainty: possible
 127 Ref: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
 128 Info: The license paragraph in the machine-readable copyright file is not
 129  referenced by any files paragraph.  It could be a typo in the license name or
 130  the license paragraph is simply not needed and can be removed.
 131
 132 Tag: unknown-paragraph-in-dep5-copyright
 133 Severity: normal
 134 Certainty: possible
 135 Ref: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
 136 Info: The machine-readable copyright file contains a paragraph that is neither
 137  a standalone license paragraph nor a files paragraph.
 138
 139 Tag: field-name-typo-in-dep5-copyright
 140 Severity: normal
 141 Certainty: possible
 142 Info: The listed field name is a likely misspelling of one of the documented
 143  DEP-5 fields.
 144  .
 145  Lintian will continue by using the "misspelled" variant, but other parsers
 146  are unlikely to do so.
 147  .
 148  Implementation detail: The typo is detected by using "Levenshtein
 149  edit distance".  Therefore, if the typo involve several characters,
 150  Lintian may not detect it.
 151
 152 Tag: ambiguous-paragraph-in-dep5-copyright
 153 Severity: normal
 154 Certainty: possible
 155 Ref: #652380, http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
 156 Info: The paragraph has a "License" and a "Copyright" field, but no
 157  "Files" field.  Technically, this is a valid paragraph per the DEP-5
 158  specification.  However, it is mostly likely a mistake.
 159  .
 160  If it is a <tt>stand-alone license paragraph</tt>, the "Copyright"
 161  field is not needed and should be removed.  On the other hand, if it
 162  is a <tt>files paragraph</tt>, it is missing the "Files" field.
 163  .
 164  Please note that while the "Files" field was optional in some cases
 165  in some of the earlier draft versions, it is mandatory in <i>all</i>
 166  <tt>files paragraphs</tt> in the current specification.
 167  .
 168  Lintian will attempt to guess what you intended and continue based on
 169  its guess.  If the guess is wrong, you may see spurious tags related
 170  to this paragraph.