921e7b99385e4a0301be40bbceb480347836e769
[lintian/lintian.git] / 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, unpacked
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: no-dep5-copyright
27 Severity: pedantic
28 Certainty: possible
29 Info: This package does not use Machine-readable debian/copyright file.
30  .
31  This format help to review license problem and could be easily parsed
32  by Lintian.
33 Ref: https://dep.debian.net/deps/dep5/
34
35 Tag: unknown-copyright-format-uri
36 Severity: pedantic
37 Certainty: wild-guess
38 Info: The copyright file appears to intended as machine-readable, but lintian
39  cannot recognize its format URI.  It could be a typo for a common URI or a
40  syntax error in the first paragraph.  Please file a bug against Lintian if you
41  believe that the copyright file in syntactically valid and the URI is
42  correct.
43
44 Tag: boilerplate-copyright-format-uri
45 Severity: normal
46 Certainty: possible
47 Info: Format URI of the machine-readable copyright file contains
48  <tt>VERSIONED_FORMAT_URL</tt> or <tt>REVISION</tt> string.  Please replace it
49  with an actual URI or an actual revision number respectively.
50
51 Tag: wiki-copyright-format-uri
52 Severity: pedantic
53 Certainty: possible
54 Ref: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
55 Info: Format URI of the machine-readable copyright file refers to Debian Wiki.
56  .
57  Debian Wiki is not used for the format development anymore.  Please use
58  <tt>https://www.debian.org/doc/packaging-manuals/copyright-format/<i>version</i>/</tt>
59  as the format URI instead.
60
61 Tag: unversioned-copyright-format-uri
62 Severity: pedantic
63 Certainty: possible
64 Ref: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
65 Info: Format URI of the machine-readable copyright file is not versioned.
66  .
67  Please use
68  <tt>https://www.debian.org/doc/packaging-manuals/copyright-format/<i>version</i>/</tt>
69  as the format URI instead.
70
71 Tag: out-of-date-copyright-format-uri
72 Severity: pedantic
73 Certainty: possible
74 Ref: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
75 Info: A newer version of the machine-readable copyright file specification,
76  than the one referenced by the copyright file, is available.
77  .
78  This problem may have prevented lintian from performing other checks.
79
80 Tag: syntax-error-in-dep5-copyright
81 Severity: normal
82 Certainty: possible
83 Ref: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
84 Info: The machine-readable copyright file didn't pass Debian control file
85  syntax check.
86  .
87  This issue may hide other issues as Lintian skips some checks on the
88  file in this case.
89
90 Tag: obsolete-field-in-dep5-copyright
91 Severity: normal
92 Certainty: possible
93 Ref: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
94 Info: The machine-readable copyright file uses a field, that used to be defined
95  by the specification, but has been renamed since then.
96  .
97  Please use Format instead of Format-Specification.
98  .
99  Please use Upstream-Contact instead of Contact, Maintainer or Upstream-Maintainer.
100  .
101  Please use Upstream-Name instead of Name.
102
103 Tag: comma-separated-files-in-dep5-copyright
104 Severity: normal
105 Certainty: possible
106 Ref: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
107 Info: A list of files in the machine-readable copyright format appears to be
108  separated by commas.  The file list should be whitespace separated instead.
109  .
110  Please note this tag is only emitted once per checked copyright file.
111
112 Tag: missing-field-in-dep5-copyright
113 Severity: normal
114 Certainty: possible
115 Ref: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
116 Info: The paragraph in the machine readable copyright file is missing a field
117  that is required by the specification.
118
119 Tag: empty-short-license-in-dep5-copyright
120 Severity: normal
121 Certainty: possible
122 Ref: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
123 Info: The short license field in the machine readable copyright file
124  is empty.
125
126 Tag: license-problem-undefined-license
127 Severity: serious
128 Certainty: possible
129 Ref: https://ftp-master.debian.org/REJECT-FAQ.html
130 Info: Your copyright file references a license that is not defined.
131  Due to copyright law or treaties, files that are not available under
132  a defined license are non-free and non-re-distributable. 
133  .
134  Referencing an undefined license could mean the file cannot be 
135  distributed in Debian or it could simply mean that the existing 
136  license needs to be documented. In both cases,
137  the copyright file should be updated to reflect reality. 
138  .
139  Please re-package the package without the file (if possible)
140  or ask the FTP-masters to remove the package.
141  .
142  If the package has been uploaded to Debian before, and if
143  affected files cannot be distributed in Debian please
144  remember to also notify snapshot.debian.org about this
145  package containing a non-distributable file.
146
147 Tag: missing-license-paragraph-in-dep5-copyright
148 Severity: normal
149 Certainty: possible
150 Ref: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
151 Info: The files paragraph in the machine readable copyright file references a
152  license, for which no standalone license paragraph exists.
153
154 Tag: missing-license-text-in-dep5-copyright
155 Severity: normal
156 Certainty: possible
157 Ref: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
158 Info: The standalone license header contains only short license name, but not
159  the license text.
160
161 Tag: unused-license-paragraph-in-dep5-copyright
162 Severity: minor
163 Certainty: possible
164 Ref: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
165 Info: The license paragraph in the machine-readable copyright file is not
166  referenced by any files paragraph.  It could be a typo in the license name or
167  the license paragraph is simply not needed and can be removed.
168
169 Tag: unknown-paragraph-in-dep5-copyright
170 Severity: normal
171 Certainty: possible
172 Ref: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
173 Info: The machine-readable copyright file contains a paragraph that is neither
174  a standalone license paragraph nor a files paragraph.
175
176 Tag: field-name-typo-in-dep5-copyright
177 Severity: normal
178 Certainty: possible
179 Info: The listed field name is a likely misspelling of one of the documented
180  DEP-5 fields.
181  .
182  Lintian will continue by using the "misspelled" variant, but other parsers
183  are unlikely to do so.
184  .
185  Implementation detail: The typo is detected by using "Levenshtein
186  edit distance".  Therefore, if the typo involve several characters,
187  Lintian may not detect it.
188
189 Tag: ambiguous-paragraph-in-dep5-copyright
190 Severity: normal
191 Certainty: possible
192 Ref: #652380, https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
193 Info: The paragraph has a "License" and a "Copyright" field, but no
194  "Files" field.  Technically, this is a valid paragraph per the DEP-5
195  specification.  However, it is mostly likely a mistake.
196  .
197  If it is a <tt>stand-alone license paragraph</tt>, the "Copyright"
198  field is not needed and should be removed.  On the other hand, if it
199  is a <tt>files paragraph</tt>, it is missing the "Files" field.
200  .
201  Please note that while the "Files" field was optional in some cases
202  in some of the earlier draft versions, it is mandatory in <i>all</i>
203  <tt>files paragraphs</tt> in the current specification.
204  .
205  Lintian will attempt to guess what you intended and continue based on
206  its guess.  If the guess is wrong, you may see spurious tags related
207  to this paragraph.