/usr/share/lintian/checks/changelog-file.desc is in lintian 2.5.10.4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 | Check-Script: changelog-file
Author: Christian Schwarz <schwarz@debian.org>
Abbrev: chg
Type: binary
Needs-Info: file-info, changelog-file, index
Info: This script checks if a binary package conforms to policy
with regards to changelog files.
.
Each binary package with a /usr/share/doc/<foo> directory must have
a Debian changelog file in <tt>changelog.Debian.gz</tt> unless the Debian
changelog and the upstream one is the same file; in this case, it
must be in <tt>changelog.gz</tt>.
.
If there is an upstream changelog file, it must be named
"changelog.gz".
.
Both changelog files should be compressed using "gzip -9".
Even if they start out small, they will become large with time.
Tag: html-changelog-without-text-version
Severity: important
Certainty: certain
Info: If the upstream changelog file is HTML formatted, a text version
should also be accessible as "changelog.gz". (This can be created by
"lynx -dump -nolist")
Ref: policy 12.7
Tag: changelog-file-not-compressed
Severity: important
Certainty: certain
Info: Changelog files should be compressed using "gzip -9". Even if they
start out small, they will become large with time.
Ref: policy 12.7
Tag: debian-news-file-not-compressed
Severity: normal
Certainty: certain
Info: NEWS.Debian files should be compressed using "gzip -9". The file
must always have the same name.
Ref: devref 6.3.4
Tag: changelog-not-compressed-with-max-compression
Severity: normal
Certainty: certain
Info: Changelog files should be compressed using "gzip -9"; i.e., using
the maximum compression level via the -9 option to gzip.
Ref: policy 12.7
Tag: wrong-name-for-changelog-of-native-package
Severity: normal
Certainty: certain
Info: The changelog file of a native Debian package (i.e., if there is
no upstream source) should usually be installed as
/usr/share/doc/<i>pkg</i>/changelog.gz
Ref: policy 12.7
Tag: changelog-file-missing-in-native-package
Severity: important
Certainty: certain
Info: Each Debian package (which provides a /usr/share/doc/<i>pkg</i>
directory) has to install a changelog file. Since this package seems
to be a native Debian package (i.e., there is no upstream source),
the file should usually be installed as
/usr/share/doc/<i>pkg</i>/changelog.gz
.
Note that Lintian may emit this tag if the changelog exists, but it
does not look like a Debian changelog.
Ref: policy 12.7
Tag: wrong-name-for-upstream-changelog
Severity: normal
Certainty: possible
Info: If there is an upstream changelog file, it should usually be
installed as /usr/share/doc/<i>pkg</i>/changelog.gz
Ref: policy 12.7
Tag: no-upstream-changelog
Severity: pedantic
Certainty: wild-guess
Info: The package does not install an upstream changelog file. If upstream
provides a changelog, it should be accessible as
<tt>/usr/share/doc/<i>pkg</i>/changelog.gz</tt>.
.
It's currently unclear how best to handle multiple binary packages from
the same source. Some maintainers put a copy of the upstream changelog
in each package, but it can be quite long. Some include it in one
package and add symlinks to the other packages, but this requires there
be dependencies between the packages. Some only include it in a "central"
binary package and omit it from more ancillary packages.
Ref: policy 12.7
Tag: wrong-name-for-debian-changelog-file
Severity: important
Certainty: certain
Info: The Debian changelog file should usually be installed as
/usr/share/doc/<i>pkg</i>/changelog.Debian.gz
Ref: policy 12.7
Tag: wrong-name-for-debian-news-file
Severity: normal
Certainty: possible
Info: The Debian news file must be installed as
/usr/share/doc/<i>pkg</i>/NEWS.Debian.gz with exactly that capitalization
or automated tools may not find it correctly.
Ref: devref 6.3.4
Tag: debian-changelog-file-missing
Severity: serious
Certainty: certain
Info: Each Debian package (which provides a /usr/share/doc/<i>pkg</i>
directory) has to install a Debian changelog file
/usr/share/doc/<i>pkg</i>/changelog.Debian.gz
Ref: policy 12.7
Tag: debian-changelog-file-is-a-symlink
Severity: normal
Certainty: certain
Info: The Debian changelog file is a symlink to a file in a different
directory or not found in this package. Please don't do this. It makes
package checking and manipulation unnecessarily difficult. Because it was
a symlink, the Debian changelog file was not checked for other
problems. (Symlinks to another file in /usr/share/doc/<i>pkg</i> or a
subdirectory thereof are fine and should not trigger this warning.)
.
To refer to the changelog, copyright, and other documentation files of
another package that this one depends on, please symlink the entire
/usr/share/doc/<i>pkg</i> directory rather than individual files.
Tag: debian-changelog-file-missing-or-wrong-name
Severity: serious
Certainty: certain
Info: Each Debian package (which provides a /usr/share/doc/<i>pkg</i>
directory) must install a Debian changelog file in
/usr/share/doc/<i>pkg</i>/changelog.Debian.gz
.
A common error is to name the Debian changelog like an upstream changelog
(/usr/share/doc/<i>pkg</i>/changelog.gz); therefore, lintian will apply
further checks to such a file if it exists even after issuing this error.
Ref: policy 12.7
Tag: debian-changelog-file-contains-obsolete-user-emacs-settings
Severity: normal
Certainty: certain
Info: The add-log-mailing-address variable is no longer honored in
debian-changelog-mode, and should not appear in packages' changelog
files. Instead, put something like this in your ~/.emacs:
.
(setq debian-changelog-mailing-address "userid@debian.org")
Tag: debian-changelog-file-contains-invalid-email-address
Severity: important
Certainty: certain
Info: The changelog file contains an invalid email address: the domain
needs at least one dot. This looks like a mistake.
Tag: debian-changelog-file-uses-obsolete-national-encoding
Severity: serious
Certainty: certain
Ref: policy 4.4
Info: The Debian changelog file must be valid UTF-8, an encoding of
the Unicode character set.
.
There are many ways to convert a changelog from an obsoleted encoding
like ISO-8859-1; you may for example use "iconv" like:
.
$ iconv -f ISO-8859-1 -t UTF-8 changelog > changelog.new
$ mv changelog.new changelog
Tag: debian-news-file-uses-obsolete-national-encoding
Severity: important
Certainty: certain
Info: The NEWS.Debian file must be valid UTF-8, an encoding of the Unicode
character set.
.
There are many ways to convert a changelog from an obsoleted encoding
like ISO-8859-1; you may for example use "iconv" like:
.
$ iconv -f ISO-8859-1 -t UTF-8 NEWS.Debian > NEWS.Debian.new
$ mv NEWS.Debian.new NEWS.Debian
Tag: latest-debian-changelog-entry-without-new-date
Severity: normal
Certainty: certain
Info: The latest Debian changelog entry has either the same or even an
older date as the entry before.
Tag: latest-debian-changelog-entry-without-new-version
Severity: normal
Certainty: certain
Info: The latest Debian changelog entry has a version number that's either
the same or smaller than the version number of the entry before.
Tag: latest-debian-changelog-entry-changed-to-native
Severity: normal
Certainty: possible
Info: The latest package has a Debian native version number, while the
previous version number was not native. This is usually a mistake made by
the maintainer by forgetting to append -1 when uploading a new upstream
version.
Tag: possible-new-upstream-release-without-new-version
Severity: normal
Certainty: possible
Info: The most recent changelog entry contains an entry that appears to
say this is a new upstream release (a comment similar to "new upstream
release," possibly with a word between "upstream" and "release"), but the
upstream portion of the package version number didn't change. This may
indicate that the package version was not updated properly in
<tt>debian/changelog</tt>.
Tag: experimental-to-unstable-without-comment
Severity: pedantic
Certainty: possible
Info: The previous version of this package had a distribution of
experimental, this version has a distribution of unstable, and there's
apparently no comment about the change of distributions (Lintian looks
for the phrase "to unstable"). This may indicate a mistake in setting
the distribution and accidentally uploading to unstable a package
intended for experimental.
Tag: syntax-error-in-debian-changelog
Severity: normal
Certainty: possible
Info: While parsing the Debian changelog, a syntax error was found. If
you have old changelog entries that don't follow the current syntax but
that you want to keep as-is for the historical record, add the line:
.
Old Changelog:
.
with no leading whitespace before the legacy entries. This line and
everything after it will be ignored.
Ref: policy 4.4
Tag: syntax-error-in-debian-news-file
Severity: normal
Certainty: possible
Info: While parsing the NEWS.Debian file, a syntax error was found.
Ref: devref 6.3.4
Tag: improbable-bug-number-in-closes
Severity: normal
Certainty: possible
Info: The most recent changelog closes a bug numbered less than 100.
While this is distantly possible, it's more likely a typo or a
placeholder value that mistakenly wasn't filled in.
Tag: wrong-bug-number-in-closes
Severity: normal
Certainty: certain
Info: Bug numbers can only contain digits.
Ref: policy 4.4
Tag: possible-missing-colon-in-closes
Severity: important
Certainty: possible
Info: To close a bug in the Debian changelog, the word "closes" must be
followed by a colon. This entry looked like it was intended to close a
bug, but there's no colon after "closes".
Ref: policy 4.4
Tag: debian-news-entry-has-strange-distribution
Severity: normal
Certainty: certain
Info: The latest entry in NEWS.Debian has an unusual distribution name.
This field is ignored by the archive software, so its value doesn't truly
matter, but it may be confusing to users reading the entry if the
distribution doesn't match the distribution for the same entry in the
Debian changelog file.
Tag: debian-news-entry-uses-asterisk
Severity: wishlist
Certainty: possible
Info: The latest entry in NEWS.Debian appears to use asterisks to present
changes in a bulleted list, similar to the normal changelog syntax. The
Debian Developer's Reference recommends using regular paragraphs in
NEWS.Debian rather than a bulleted list.
Ref: devref 6.3.4
Tag: debian-news-entry-has-unknown-version
Severity: normal
Certainty: possible
Info: The version number of the most recent <tt>NEWS.Debian</tt> entry
does not match any of the version numbers in the changelog file for this
package. This usually means the version in <tt>NEWS.Debian</tt> needs to
be updated to match a change to package version that happened after the
<tt>NEWS.Debian</tt> entry was written.
Tag: spelling-error-in-changelog
Severity: minor
Certainty: certain
Info: Lintian found a spelling error in the latest entry of the Debian
changelog. Lintian has a list of common misspellings that it looks for.
It does not have a dictionary like a spelling checker does.
.
When writing a changelog entry for a spelling fix that includes the
misspelling, ensure the word "spelling" is on the same line as the
misspelled word to avoid triggering this warning.
Tag: spelling-error-in-news-debian
Severity: minor
Certainty: certain
Info: Lintian found a spelling error in the latest entry of the
NEWS.Debian file. Lintian has a list of common misspellings that it
looks for. It does not have a dictionary like a spelling checker does.
Tag: new-package-should-close-itp-bug
Severity: normal
Certainty: certain
Info: This package appears to be the first packaging of a new upstream
software package (there is only one changelog entry and the Debian
revision is 1), but it does not close any bugs. The initial upload of a
new package should close the corresponding ITP bug for that package.
.
This warning can be ignored if the package is not intended for Debian or
if it is a split of an existing Debian package.
Ref: devref 5.1
Tag: debian-changelog-line-too-long
Severity: normal
Certainty: certain
Info: The given line of the latest changelog entry is over 80 columns.
Such changelog entries may look poor in terminal windows and mail
messages and be annoying to read. Please wrap changelog entries at 80
columns or less where possible.
Tag: changelog-news-debian-mismatch
Severity: normal
Certainty: possible
Info: The latest entries in the Debian changelog file and NEWS.Debian file
are for the same version but the given field doesn't match. The
changelog information is canonical and the NEWS.Debian information is
ignored, but it may be confusing to users to have them be different.
Tag: version-refers-to-distribution
Severity: minor
Certainty: certain
Info: The Debian portion of the package version contains a reference to a
particular Debian release or distribution. This should only be done for
uploads targeted at a particular release, not at unstable or
experimental, and should refer to the release by version number or code
name.
.
Using "testing" or "stable" in a package version targeted at the current
testing or stable release is less informative than using the code name or
version number and may cause annoying version sequencing issues if the
package doesn't change before the next release cycle starts.
Ref: devref 5.13.3
|