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

   1 Check-Script: menus
   2 Author: Christian Schwarz <schwarz@debian.org>
   3 Abbrev: men
   4 Type: binary
   5 Unpack-Level: 1
   6 Needs-Info: doc-base-files
   7
   8 Tag: postinst-should-not-set-usr-doc-link
   9 Type: warning
  10 Info: The technical committee chose the symlink transition method to move
  11  from FSSTND to FHS.  That transition has been completed with woody and thus
  12  this link is no longer required.
  13
  14 Tag: maintainer-script-does-not-check-for-existence-of-updatemenus
  15 Type: error
  16 Info: The maintainer script calls the <tt>update-menus</tt> command without
  17  checking for existence first. (The <tt>menu</tt> package which provides the
  18  command is not marked as `essential' package.)
  19  .
  20  For example, use the following code in your maintainer script:
  21   if [ -x /usr/bin/update-menus ] ; then update-menus ; fi
  22
  23 Tag: maintainer-script-does-not-check-for-existence-of-wm-menu-config
  24 Type: error
  25 Info: The maintainer script calls the <tt>wm-menu-config</tt> command without
  26  checking for existence first. (The <tt>menu</tt> package which provides
  27  the command is not marked as `essential' package.)
  28  .
  29  For example, use the following code in your maintainer script:
  30   if [ -x /usr/sbin/wm-menu ]; then /usr/sbin/wm-menu-config; fi
  31
  32 Tag: maintainer-script-does-not-check-for-existence-of-installdocs
  33 Type: error
  34 Info: The maintainer script calls the <tt>install-docs</tt> command without
  35  checking for existence first. (The <tt>doc-base</tt> package which provides
  36  the command is not marked as `essential' package.)
  37  .
  38  For example, use the following code in your maintainer script:
  39   if [ -x /usr/sbin/install-docs ]; then
  40     /usr/sbin/install-docs -i /usr/share/doc-base/&lt;your-package&gt;
  41   fi
  42
  43 Tag: maintainer-script-calls-deprecated-wm-menu-config
  44 Type: warning
  45 Info: The use of the wm-menu-config script is deprecated because it's
  46  design had some serious flaws. Please see the menu documentation,
  47  chapter 5 for more information.
  48
  49 Tag: preinst-calls-updatemenus
  50 Type: error
  51 Info: The preinst script calls the <tt>update-menus</tt> command. Usually,
  52  this command should be called from the <tt>postinst</tt> maintainer script.
  53
  54 Tag: preinst-calls-installdocs
  55 Type: error
  56 Info: The preinst script calls the <tt>install-docs</tt> command. Usually,
  57  this command should be called from the <tt>postinst</tt> maintainer script.
  58
  59 Tag: prerm-calls-updatemenus
  60 Type: error
  61 Info: The prerm script calls the <tt>update-menus</tt> command. Usually,
  62  this command should be called from the <tt>postrm</tt> maintainer script.
  63
  64 Tag: postrm-calls-installdocs
  65 Type: error
  66 Info: The postrm script calls the <tt>install-docs</tt> command. Usually,
  67  this command should be called from the <tt>prerm</tt> maintainer script.
  68
  69 Tag: executable-menu-file
  70 Type: warning
  71 Info: Menu files should normally not be marked as executables. You only
  72  need to do this if your package has to generate menu entries dynamically.
  73
  74 Tag: menu-file-in-usr-lib
  75 Type: warning
  76 Info: As of menu, version 2.1.25, /usr/lib/menu as location for menu
  77  files is deprecated (but still works perfectly). Menu files should
  78  now be placed in /usr/share/menu instead. Only menu files that are
  79  actually binary executables still need to go to /usr/lib/menu.
  80
  81 Tag: executable-in-usr-share-docbase
  82 Type: error
  83 Info: Files in <tt>/usr/share/doc-base</tt> may not be marked as executables.
  84
  85 Tag: postinst-does-not-call-installdocs
  86 Type: error
  87 Info: Since the package installs a file in <tt>/usr/share/doc-base</tt>, the
  88  package should probably call the <tt>install-docs</tt> command in its
  89  <tt>postinst</tt> script.
  90  .
  91  For example, use the following code in your maintainer script:
  92   if [ -x /usr/sbin/install-docs ]; then
  93     /usr/sbin/install-docs -i /usr/share/doc-base/&lt;your-package&gt;
  94   fi
  95
  96 Tag: prerm-does-not-call-installdocs
  97 Type: error
  98 Info: Since the package installs a file in <tt>/usr/share/doc-base</tt>, the
  99  package should probably call the <tt>install-docs</tt> command in its
 100  <tt>prerm</tt> script.
 101  .
 102  For example, use the following code in your maintainer script:
 103   if [ -x /usr/sbin/install-docs ]; then
 104     /usr/sbin/install-docs -r &lt;your-package&gt; || true
 105   fi
 106
 107 Tag: postinst-does-not-call-updatemenus
 108 Type: error
 109 Info: Since the package installs a file in either <tt>/usr/lib/menu</tt> or
 110  <tt>/etc/menu-methods</tt>, the package should probably call the
 111  <tt>update-menus</tt> command in it's <tt>postinst</tt> script.
 112  .
 113  For example, use the following code in your maintainer script:
 114   if [ -x /usr/bin/update-menus ] ; then update-menus ; fi
 115
 116 Tag: postrm-does-not-call-updatemenus
 117 Type: error
 118 Info: Since the package installs a file in either <tt>/usr/lib/menu</tt> or
 119  <tt>/etc/menu-methods</tt>, the package should probably call the
 120  <tt>update-menus</tt> command in it's <tt>postrm</tt> script.
 121  .
 122  For example, use the following code in your maintainer script:
 123   if [ -x /usr/bin/update-menus ] ; then update-menus ; fi
 124
 125 Tag: postinst-has-useless-call-to-update-menus
 126 Type: warning
 127 Info: The <tt>postinst</tt> script calls the <tt>update-menus</tt> program
 128  though no file is installed in <tt>/usr/lib/menu</tt> or
 129  <tt>/etc/menu-methods</tt>.
 130
 131 Tag: postrm-has-useless-call-to-update-menus
 132 Type: warning
 133 Info: The <tt>postrm</tt> script calls the <tt>update-menus</tt> program
 134  though no file is installed in <tt>/usr/lib/menu</tt> or
 135  <tt>/etc/menu-methods</tt>
 136
 137 Tag: postinst-has-useless-call-to-install-docs
 138 Type: error
 139 Info: The <tt>postinst</tt> script calls the <tt>install-docs</tt> program
 140  though no file is installed in <tt>/usr/share/doc-base</tt>.
 141
 142 Tag: prerm-has-useless-call-to-install-docs
 143 Type: error
 144 Info: The <tt>prerm</tt> script calls the <tt>install-docs</tt> program
 145  though no file is installed in <tt>/usr/share/doc-base</tt>.
 146
 147 Tag: bad-menu-file-name
 148 Severity: 4
 149 Significance: 3
 150 Info: The package installs a file <tt>/usr/lib/menu/menu</tt>, which is
 151  already in use by the <tt>menu</tt> package itself.  The menu file should
 152  be named after the package that installs it.
 153
 154 Tag: doc-base-file-references-usr-doc
 155 Type: warning
 156 Info: Files in <tt>/usr/share/doc-base</tt> should only contain links to
 157  files in the <tt>/usr/share/doc</tt> directory.
 158
 159 Tag: doc-base-index-references-multiple-files
 160 Type: error
 161 Info: The Index field in a doc-base file should reference the single index
 162  file for that document.  Any other files belonging to the same document
 163  should be listed in the Files field.
 164 Ref: Debian doc-base Manual section 2.3.2.2
 165
 166 Tag: doc-base-file-references-missing-file
 167 Type: error
 168 Info: One of the files referenced in an Index or Files field in this
 169  doc-base control file does not exist in the package.  The doc-base
 170  control files should be installed by the package that provides the
 171  documents they are registering.
 172
 173 Tag: doc-base-file-unknown-format
 174 Type: warning
 175 Info: The Format field in this doc-base control file declares a format
 176  that is not supported.  Recognized formats are "HTML", "Text", "PDF",
 177  "PostScript", "Info", "DVI", and "DebianDoc-SGML" (case-insensitive).
 178 Ref: Debian doc-base Manual section 2.3.2.2
 179
 180 Tag: doc-base-file-no-format
 181 Type: error
 182 Info: A format section of this doc-base control file didn't specify a
 183  format.  Each section after the first must specify a format.
 184 Ref: Debian doc-base Manual section 2.3.2.2
 185
 186 Tag: doc-base-file-no-format-section
 187 Type: error
 188 Info: This doc-base control file didn't specify any format
 189  section.
 190 Ref: Debian doc-base Manual section 2.3.2.2
 191
 192 Tag: doc-base-file-no-index
 193 Type: error
 194 Info: Format sections in doc-base control files for HTML or Info documents
 195  must contain an Index field specifying the starting document for the
 196  documentation.  Even if the documentation is a single file, this field
 197  must be present.
 198 Ref: Debian doc-base Manual section 2.3.2.2
 199
 200 Tag: doc-base-document-field-ends-in-whitespace
 201 Type: error
 202 Info: The Document field in a doc-base file should not end in whitespace.
 203  doc-base (at least as of 0.8.5) cannot cope with such fields and
 204  debhelper 5.0.57 or earlier may create files ending in whitespace when
 205  installing such files.
 206
 207 Tag: doc-base-document-field-not-in-first-line
 208 Type: error
 209 Info: The Document field in doc-base control file must be located at
 210  first line of the file.  While unregistering documents, doc-base 0.8
 211  and later parses only the first line of the control file for performance
 212  reasons.
 213 Ref: Debian doc-base Manual section 2.3.2.1
 214
 215 Tag: doc-base-file-unknown-field
 216 Type: error
 217 Info: The doc-base control file contains field which is either unknown
 218  or not valid for the section where was found.  Possible reasons for this
 219  error are: a typo in field name, missing empty line between control file
 220  sections, or an extra empty line separating sections.
 221 Ref: Debian doc-base Manual sections 2.3.2.1 and 2.3.2.2
 222
 223 Tag: doc-base-file-duplicated-field
 224 Type: error
 225 Info: The doc-base control file contains duplicated field.
 226
 227 Tag: doc-base-file-duplicated-format
 228 Type: error
 229 Info: The doc-base control file contains a duplicated format.  Doc-base
 230  files must not register different documents in one control file.
 231 Ref: Debian doc-base Manual section 2.3.2.2
 232
 233 Tag: doc-base-file-lacks-required-field
 234 Type: error
 235 Info: The doc-base control file does not contain a required field for the
 236  appropriate section.
 237 Ref: Debian doc-base Manual sections 2.3.2.1 and 2.3.2.2
 238
 239 Tag: doc-base-invalid-document-field
 240 Type: error
 241 Info: The Document field should consists only of letters (a-z), digits
 242  (0-9), plus (+) or minus (-) signs, and dots (.).  In particular,
 243  uppercase letters are not allowed.
 244 Ref: Debian doc-base Manual section 2.2
 245
 246 Tag: doc-base-abstract-field-is-template
 247 Type: warning
 248 Info: The Abstract field of doc-base contains a "manage online manuals"
 249  phrase, which was copied verbatim from an example control file found in
 250  section 2.3.1 of the Debian doc-base Manual.
 251
 252 Tag: doc-base-abstract-might-contain-extra-leading-whitespaces
 253 Type: warning
 254 Info: Continuation lines of the Abstract field of doc-base control file
 255  should start with only one space unless they are meant to be displayed
 256  verbatim by fontends.
 257 Ref: Debian doc-base Manual section 2.3.2
 258
 259 Tag: doc-base-abstract-field-separator-extra-whitespaces
 260 Type: warning
 261 Info: Unnecessary spaces were found in the paragraph separator line of the
 262  doc-base's Abstract field.  The separator line should consist of a single
 263  space followed by a single dot.
 264 Ref: Debian doc-base Manual section 2.3.2
 265
 266 Tag: spelling-error-in-doc-base-title-field
 267 Type: warning
 268 Info: Lintian found a spelling or capitalization error in the Title field
 269  of this doc-base control file.  Lintian has a list of common misspellings
 270  that it looks for.  It does not have a dictionary like a spelling checker
 271  does.
 272
 273 Tag: spelling-error-in-doc-base-abstract-field
 274 Type: warning
 275 Info: Lintian found a spelling or capitalization error in the Abstract
 276  field of this doc-base control file.  Lintian has a list of common
 277  misspellings that looks for.  It does not have a dictionary like a
 278  spelling checker does.
 279
 280 Tag: doc-base-file-syntax-error
 281 Type: error
 282 Info: Lintian found a syntax error in the doc-base control file.
 283 Ref: Debian doc-base Manual section 2.3.2.2
 284
 285 Tag: doc-base-file-separator-extra-whitespaces
 286 Type: warning
 287 Info: Unnecessary spaces were found in the doc-base file sections'
 288  separator.  The section separator is an empty line and should not contain
 289  any whitespace.
 290 Ref: Debian doc-base Manual section 2.3.2
 291
 292 Tag: doc-base-file-uses-obsolete-national-encoding
 293 Type: error
 294 Info: doc-base files must be valid UTF-8, an encoding of the Unicode
 295  character set.
 296  .
 297  There are many ways to convert a doc-base file from an obsolete encoding
 298  like ISO-8859-1.  You may, for example, use "iconv" like:
 299  .
 300   $ iconv -f ISO-8859-1 -t UTF-8 doc-base &gt; doc-base.new
 301   $ mv doc-base.new doc-base
 302 Ref: Debian doc-base Manual section 2.3.2
 303
 304 Tag: doc-base-unknown-section
 305 Type: warning
 306 Info: The section indicated in this doc-base control file is not one of
 307  the standard doc-base sections.  The doc-base sections are based on the
 308  menu sections but are not exactly the same.
 309 Ref: Debian doc-base Manual section 2.3.3
 310
 311 Tag: menu-method-should-include-menu-h
 312 Type: error
 313 Info: A menu-method file must include the menu.h configuration file
 314  (using "!include menu.h").
 315 Ref: Debian Menu System manual section 5