vcs.maemo.org Git - maemian/blob - nokia-lintian/checks/changelog-file.desc

   1 Check-Script: changelog-file
   2 Author: Christian Schwarz <schwarz@debian.org>
   3 Abbrev: chg
   4 Type: binary
   5 Unpack-Level: 1
   6 Needs-Info: file-info, changelog-file
   7 Info: This script checks if a binary package conforms to policy
   8  with regards to changelog files.
   9  .
  10  Each binary package with a /usr/share/doc/&lt;foo&gt; directory must have
  11  a Debian changelog file in "changelog.Debian.gz" unless the Debian
  12  changelog and the upstream one is the same file; in this case, it
  13  must be in "changelog.gz".
  14  .
  15  If there is an upstream changelog file, it must be named
  16  "changelog.gz".
  17  .
  18  Both changelog files should be compressed using "gzip -9".
  19  Even if they start out small, they will become large with time.
  20
  21 Tag: html-changelog-without-text-version
  22 Type: error
  23 Info: If the upstream changelog file is HTML formatted, a text version
  24  should also be accessible as "changelog.gz". (This can be created by
  25  "lynx -dump -nolist")
  26 Ref: policy 12.7
  27
  28 Tag: changelog-file-not-compressed
  29 Type: warning
  30 Info: Changelog files should be compressed using "gzip -9".  Even if they
  31  start out small, they will become large with time.
  32 Ref: policy 12.7
  33
  34 Tag: debian-news-file-not-compressed
  35 Type: warning
  36 Info: NEWS.Debian files should be compressed using "gzip -9".  The file
  37  must always have the same name.
  38 Ref: devref 6.3.4
  39
  40 Tag: changelog-not-compressed-with-max-compression
  41 Type: warning
  42 Info: Changelog files should be compressed using "gzip -9"; i.e., using
  43  the maximum compression level via the -9 option to gzip.
  44 Ref: policy 12.7
  45
  46 Tag: wrong-name-for-changelog-of-native-package
  47 Type: warning
  48 Info: The changelog file of a native Debian package (i.e., if there is
  49  no upstream source) should usually be installed as
  50  /usr/share/doc/<i>pkg</i>/changelog.gz
  51 Ref: policy 12.7
  52
  53 Tag: changelog-file-missing-in-native-package
  54 Type: error
  55 Info: Each Debian package (which provides a /usr/share/doc/<i>pkg</i>
  56  directory) has to install a changelog file. Since this package seems
  57  to be a native Debian package (i.e., there is no upstream source),
  58  the file should usually be installed as
  59  /usr/share/doc/<i>pkg</i>/changelog.gz
  60 Ref: policy 12.7
  61
  62 Tag: wrong-name-for-upstream-changelog
  63 Type: warning
  64 Info: If there is an upstream changelog file, it should usually be
  65  installed as /usr/share/doc/<i>pkg</i>/changelog.gz
  66 Ref: policy 12.7
  67
  68 Tag: no-upstream-changelog
  69 Type: warning
  70 Info: The package does not install an upstream changelog file.
  71 Ref: policy 12.7
  72
  73 Tag: wrong-name-for-debian-changelog-file
  74 Type: warning
  75 Info: The Debian changelog file should usually be installed as
  76  /usr/share/doc/<i>pkg</i>/changelog.Debian.gz
  77 Ref: policy 12.7
  78
  79 Tag: wrong-name-for-debian-news-file
  80 Type: warning
  81 Info: The Debian news file must be installed as
  82  /usr/share/doc/<i>pkg</i>/NEWS.Debian.gz with exactly that capitalization
  83  or automated tools may not find it correctly.
  84 Ref: devref 6.3.4
  85
  86 Tag: debian-changelog-file-missing
  87 Type: error
  88 Info: Each Debian package (which provides a /usr/share/doc/<i>pkg</i>
  89  directory) has to install a Debian changelog file
  90  /usr/share/doc/<i>pkg</i>/changelog.Debian.gz
  91 Ref: policy 12.7
  92
  93 Tag: debian-changelog-file-is-a-symlink
  94 Type: warning
  95 Info: The Debian changelog file is a symlink to a file in a different
  96  directory or not found in this package. Please don't do this. It makes
  97  package checking and manipulation unnecessarily difficult. Because it was
  98  a symlink, the Debian changelog file was not checked for other
  99  problems. (Symlinks to another file in /usr/share/doc/<i>pkg</i> or a
 100  subdirectory thereof are fine and should not trigger this warning.)
 101  .
 102  To refer to the changelog, copyright, and other documentation files of
 103  another package that this one depends on, please symlink the entire
 104  /usr/share/doc/<i>pkg</i> directory rather than individual files.
 105
 106 Tag: debian-changelog-file-missing-or-wrong-name
 107 Type: error
 108 Info: Each Debian package (which provides a /usr/share/doc/<i>pkg</i>
 109  directory) must install a Debian changelog file in
 110  /usr/share/doc/<i>pkg</i>/changelog.Debian.gz
 111  .
 112  A common error is to name the Debian changelog like an upstream changelog
 113  (/usr/share/doc/<i>pkg</i>/changelog.gz); therefore, lintian will apply
 114  further checks to such a file if it exists even after issuing this error.
 115 Ref: policy 12.7
 116
 117 Tag: debian-changelog-file-contains-obsolete-user-emacs-settings
 118 Type: warning
 119 Info: The add-log-mailing-address variable is no longer honored in
 120  debian-changelog-mode, and should not appear in packages' changelog
 121  files.  Instead, put something like this in your ~/.emacs:
 122  .
 123  (setq debian-changelog-mailing-address "userid@debian.org")
 124
 125 Tag: debian-changelog-file-contains-debmake-default-email-address
 126 Type: error
 127 Info: The changelog file contains an email address (&lt;..@unknown&gt;)
 128  that was not updated to the maintainer's real address.
 129
 130 Tag: debian-changelog-file-contains-invalid-email-address
 131 Type: error
 132 Info: The changelog file contains an invalid email address: the domain
 133  needs at least one dot. This is looks like a mistake.
 134
 135 Tag: debian-changelog-file-uses-obsolete-national-encoding
 136 Type: error
 137 Info: The Debian changelog file must be valid UTF-8, an encoding of
 138  the Unicode character set.
 139  .
 140  There are many ways to convert a changelog from an obsoleted encoding
 141  like ISO-8859-1; you may for example use "iconv" like:
 142  .
 143   $ iconv -f ISO-8859-1 -t UTF-8 changelog &gt; changelog.new
 144   $ mv changelog.new changelog
 145
 146 Tag: debian-news-file-uses-obsolete-national-encoding
 147 Type: error
 148 Info: The NEWS.Debian file must be valid UTF-8, an encoding of the Unicode
 149  character set.
 150  .
 151  There are many ways to convert a changelog from an obsoleted encoding
 152  like ISO-8859-1; you may for example use "iconv" like:
 153  .
 154   $ iconv -f ISO-8859-1 -t UTF-8 NEWS.Debian &gt; NEWS.Debian.new
 155   $ mv NEWS.Debian.new NEWS.Debian
 156
 157 Tag: latest-debian-changelog-entry-without-new-date
 158 Type: warning
 159 Info: The latest Debian changelog entry has either the same or even an
 160  older date as the entry before.
 161
 162 Tag: latest-debian-changelog-entry-without-new-version
 163 Type: warning
 164 Info: The latest Debian changelog entry has a version number that's either
 165  the same or smaller than the version number of the entry before.
 166
 167 Tag: syntax-error-in-debian-changelog
 168 Type: warning
 169 Info: While parsing the Debian changelog, a syntax error was found.
 170 Ref: policy 4.4
 171
 172 Tag: syntax-error-in-debian-news-file
 173 Type: warning
 174 Info: While parsing the NEWS.Debian file, a syntax error was found.
 175 Ref: devref 6.3.4
 176
 177 Tag: wrong-bug-number-in-closes
 178 Type: warning
 179 Info: Bug numbers can only contain digits.
 180 Ref: policy 4.4
 181
 182 Tag: possible-missing-colon-in-closes
 183 Type: warning
 184 Info: To close a bug in the Debian changelog, the word "closes" must be
 185  followed by a colon.  This entry looked like it was intended to close a
 186  bug, but there's no colon after "closes".
 187 Ref: policy 4.4
 188
 189 Tag: debian-news-entry-has-strange-distribution
 190 Type: warning
 191 Info: The latest entry in NEWS.Debian has an unusual distribution name.
 192  This field is ignored by the archive software, so its value doesn't truly
 193  matter, but it may be confusing to users reading the entry if the
 194  distribution doesn't match the distribution for the same entry in the
 195  Debian changelog file.
 196
 197 Tag: spelling-error-in-changelog
 198 Type: warning
 199 Info: Lintian found a spelling error in the latest entry of the Debian
 200  changelog.  Lintian has a list of common misspellings that it looks for.
 201  It does not have a dictionary like a spelling checker does.
 202  .
 203  When writing a changelog entry for a spelling fix that includes the
 204  misspelling, ensure the word "spelling" is on the same line as the
 205  misspelled word to avoid triggering this warning.
 206
 207 Tag: spelling-error-in-news-debian
 208 Type: warning
 209 Info: Lintian found a spelling error in the latest entry of the
 210  NEWS.Debian file.  Lintian has a list of common misspellings that it
 211  looks for.  It does not have a dictionary like a spelling checker does.
 212
 213 Tag: new-package-should-close-itp-bug
 214 Type: warning
 215 Info: This package appears to be the first packaging of a new upstream
 216  software package (there is only one changelog entry and the Debian
 217  revision is 1), but it does not close any bugs.  The initial upload of a
 218  new package should close the corresponding ITP bug for that package.
 219  .
 220  This warning can be ignored if the package is not intended for Debian or
 221  if it is a split of an existing Debian package.
 222 Ref: devref 5.1
 223
 224 Tag: debian-changelog-line-too-long
 225 Type: warning
 226 Info: The given line of the latest changelog entry is over 80 columns.
 227  Such changelog entries may look poor in terminal windows and mail
 228  messages and be annoying to read.  Please wrap changelog entries at 80
 229  columns or less where possible.
 230
 231 Tag: changelog-news-debian-mismatch
 232 Type: warning
 233 Info: The latest entries in the Debian changelog file and NEWS.Debian file
 234  are for the same version but the given field doesn't match.  The
 235  changelog information is canonical and the NEWS.Debian information is
 236  ignored, but it may be confusing to users to have them be different.