git.maemo.org Git - maemian/blob - checks/menu-format.desc

   1 Check-Script: menu-format
   2 Author: Joey Hess <joeyh@master.debian.org>
   3 Abbrev: mnf
   4 Needs-Info: menu-files
   5 Type: binary
   6 Unpack-Level: 2
   7 Info: This script validates the format of menu files.
   8
   9 Tag: old-format-menu-file
  10 Severity: important
  11 Certainty: certain
  12 Info: The package contains a menu file that is in the old menu file format.
  13  This format is deprecated. Convert the menu file to the new menu format.
  14  Note that lintian will not test this file for any other problems.
  15
  16 Tag: whitespace-after-continuation-character
  17 Severity: important
  18 Certainty: certain
  19 Info: The menu item is split up over 2 or more lines using '\' at the end of
  20  the line to join them together. However, there is some whitespace after
  21  the '\' character, which is not guaranteed to be handled correctly.
  22  The '\' should be at the end of the line.
  23
  24 Tag: bad-test-in-menu-item
  25 Severity: important
  26 Certainty: certain
  27 Info: The menu file contains an item that does not start with the text
  28  "?package(somepackage):". All menu file lines must test for the existence
  29  of a package in this way.
  30 Ref: menu 3.2
  31
  32 Tag: unparsable-menu-item
  33 Severity: important
  34 Certainty: certain
  35 Info: An item of the menu file cannot be parsed as a series of tag=value
  36  pairs. This could be because you didn't close a set of double quotes.
  37 Ref: menu 3.2
  38
  39 Tag: pkg-not-in-package-test
  40 Severity: normal
  41 Certainty: possible
  42 Info: This menu item doesn't test to see if the package containing it is
  43  installed.  The start of any menu item is a conditional testing whether
  44  the required packages are installed.  Normally this conditional should
  45  always check at least the package containing it, since menu items should
  46  be included in the package that provides the application the menu refers
  47  to.
  48  .
  49  This error usually indicates a misspelling of the package name in the
  50  menu entry or a copied menu entry from another package that doesn't apply
  51  to this one.
  52 Ref: menu 3.2
  53
  54 Tag: duplicated-tag-in-menu-item
  55 Severity: normal
  56 Certainty: certain
  57 Info: The menu item contains two instances of the same tag. This is just a
  58  waste of space, as menu will only use one of them.
  59 Ref: menu 3.2
  60
  61 Tag: menu-item-missing-required-tag
  62 Severity: important
  63 Certainty: certain
  64 Info: The menu item has a line that is missing a required tag. It's likely
  65  that the line will have no effect without this tag. <tt>install-menu</tt> may
  66  report this as an error during package installation.
  67
  68 Tag: menu-item-contains-unknown-tag
  69 Severity: minor
  70 Certainty: certain
  71 Info: The menu item has a line that has a tag in it that is not one
  72  of the standard tags (needs=, section=, title=, longtitle=, command=, etc).
  73  While other tags can be used for specialized purposes, this is rare and
  74  it's more likely the tag's name is misspelled.
  75
  76 Tag: menu-item-uses-icon-none
  77 Severity: minor
  78 Certainty: certain
  79 Info: The menu item has a line that uses icon=none. This is redundant and
  80  deprecated -- if there is no icon, just leave off the icon tag.
  81
  82 Tag: menu-item-needs-tag-has-unknown-value
  83 Severity: minor
  84 Certainty: certain
  85 Info: The menu item has a line that has a needs= field with a strange value.
  86  This may be intentional, but it's probably a typo that will make menu
  87  ignore the line.
  88
  89 Tag: menu-item-uses-apps-games-section
  90 Severity: normal
  91 Certainty: certain
  92 Info: The menu item has a line that specifies a section under "Apps/Games".
  93  This section has been moved to just "Games".
  94 Ref: menu-policy 2.1
  95
  96 Tag: menu-item-uses-apps-section
  97 Severity: normal
  98 Certainty: certain
  99 Info: The menu item has a line that specifies a section under "Apps".
 100  This section has been moved to "Applications".
 101 Ref: menu-policy 2.1
 102
 103 Tag: menu-item-uses-windowmanagers-section
 104 Severity: normal
 105 Certainty: certain
 106 Info: The menu item has a line that specifies a section under
 107  "WindowManagers".  This section has been moved to "Window Managers".
 108 Ref: menu-policy 2.1
 109
 110 Tag: menu-item-creates-new-section
 111 Severity: normal
 112 Certainty: certain
 113 Info: The menu item has a line that specifies an unknown section or uses a
 114  section that is intended only as a menu root, not as a section that
 115  applications should use directly.  Check the spelling of the section and
 116  check the section against the list in the menu policy.  (The menu
 117  sections changed as of June of 2007.)
 118 Ref: menu-policy 2.1
 119
 120 Tag: menu-item-creates-new-root-section
 121 Severity: important
 122 Certainty: certain
 123 Info: The menu item has a line that specifies a new section to put a menu
 124  entry in, and this section appears right in the root menu.  This is
 125  almost certainly an error.  No new sections should be added to the root
 126  menu without discussion with the author of menu.
 127
 128 Tag: menu-icon-not-in-xpm-format
 129 Severity: important
 130 Certainty: certain
 131 Info: Icons in the Debian menu system should be in XPM format.
 132 Ref: menu 3.7
 133
 134 Tag: menu-icon-missing
 135 Severity: normal
 136 Certainty: possible
 137 Info: This icon file couldn't be found.  If the path to the icon in the
 138  menu file is an absolute path, make sure that icon exists at that path in
 139  the package.  If the path is relative or a simple filename, make sure the
 140  icon is installed in <tt>/usr/share/pixmaps</tt>, the default location.
 141  .
 142  If the icon is in a package this package depends on, add a lintian
 143  override for this warning.  lintian cannot check icons in other packages.
 144 Ref: menu 3.7
 145
 146 Tag: menu-icon-too-big
 147 Severity: important
 148 Certainty: certain
 149 Info: Icons in the Debian menu system should be at most 32x32 pixels
 150  (icon16x16 icons should of course be at most 16x16 pixels)
 151 Ref: menu 3.7
 152
 153 Tag: menu-icon-cannot-be-parsed
 154 Severity: normal
 155 Certainty: certain
 156 Info: The icon file could not be parsed.  Perhaps this means a bad XPM file,
 157  or perhaps it means the lintian parsing needs to be improved.  If the
 158  window managers and standard tools accept the file then probably it's the
 159  latter; please file a bug on lintian then.
 160
 161 Tag: su-wrapper-without--c
 162 Severity: important
 163 Certainty: certain
 164 Info: The menu item command or desktop file uses an su wrapper such as
 165  su-to-root without the -c flag. This is a syntax error.
 166 Ref: su-to-root(1)
 167
 168 Tag: su-to-root-with-usr-sbin
 169 Severity: normal
 170 Certainty: certain
 171 Info: The menu item or desktop file command uses su-to-root as
 172  /usr/sbin/su-to-root. Since sarge su-to-root is located in /usr/bin and
 173  /usr/sbin/su-to-root is only a compatibility symlink that may get dropped
 174  in the future.
 175  .
 176  Since su-to-root is now located in /usr/bin you can use it without
 177  absolute path now.
 178
 179 Tag: su-wrapper-not-su-to-root
 180 Severity: normal
 181 Certainty: certain
 182 Info: The menu item or desktop file command uses an su wrapper other than
 183  su-to-root.  On Debian systems, please use <tt>su-to-root -X</tt>, which
 184  will pick the correct wrapper based on what's installed on the system and
 185  the current desktop environment.  Using su-to-root is also important for
 186  Live CD systems which need to use sudo rather than su.  su-to-root
 187  permits global configuration to use sudo.
 188
 189 Tag: menu-item-needs-dwww
 190 Severity: normal
 191 Certainty: certain
 192 Info: The menu item has needs=dwww. This is deprecated. Instead, you should
 193  register your documentation with doc-base, and dwww entries will be
 194  automatically generated.
 195
 196 Tag: non-wm-in-windowmanager-menu-section
 197 Severity: important
 198 Certainty: certain
 199 Info: The menu item is in the Window Manager section but does not needs=wm.
 200  Either it is a window manager and it should needs=wm, either it isn't and
 201  then it must be moved in another section.
 202
 203 Tag: non-wm-module-in-wm-modules-menu-section
 204 Severity: important
 205 Certainty: certain
 206 Info: The menu item is in the FVWM Modules or Window Maker section but
 207  does not declare that it needs a specific window manager (using the needs
 208  key in the menu file).  Modules for Fvwm should have needs="fvwmmodule".
 209  Modules for WindowMaker should have needs="wmmaker".
 210
 211 Tag: unquoted-string-in-menu-item
 212 Severity: normal
 213 Certainty: certain
 214 Info: The menu item includes a tag with an unquoted string like section=Games
 215  instead of section="Games". This is deprecated. Use a quoted string instead.
 216 Ref: menu 3.2
 217
 218 Tag: menu-command-not-in-package
 219 Severity: normal
 220 Certainty: possible
 221 Info: The menu item specifies a command which is not available in the package.
 222  In most cases this is a typo or after you moved a binary around, but forgot
 223  to update the menu file.
 224
 225 Tag: executable-desktop-file
 226 Severity: important
 227 Certainty: certain
 228 Info: The desktop entry file is marked executable.  Desktop entries are
 229  regular files and should be installed mode 0644.
 230
 231 Tag: desktop-entry-file-has-crs
 232 Severity: normal
 233 Certainty: certain
 234 Info: The desktop entry file has lines ending in CRLF instead of just LF.
 235  The Desktop Entry Specification is explicit that lines should end with
 236  only LF.  The CR may be taken by some software as part of the field.
 237 Ref: http://standards.freedesktop.org/desktop-entry-spec/1.0/ar01s02.html
 238
 239 Tag: duplicated-key-in-desktop-entry
 240 Severity: normal
 241 Certainty: certain
 242 Info: The desktop entry contains two instances of the same key.  The
 243  behavior of such desktop entries is not well-defined by the standard.
 244
 245 Tag: desktop-entry-missing-required-key
 246 Severity: important
 247 Certainty: certain
 248 Info: Desktop entries must contain, at a minimum, the keys Type and Name.
 249 Ref: http://standards.freedesktop.org/desktop-entry-spec/1.0/ar01s05.html
 250
 251 Tag: desktop-entry-contains-unknown-key
 252 Severity: minor
 253 Certainty: certain
 254 Info: The key on this line of the desktop entry is not one of the standard
 255  keys defined in the FreeDesktop specification, not one of the legacy KDE
 256  keywords, and one that does not begin with <tt>X-</tt>.  It's most likely
 257  that the key was misspelled.
 258 Ref: http://standards.freedesktop.org/desktop-entry-spec/1.0/ar01s05.html
 259
 260 Tag: desktop-entry-contains-deprecated-key
 261 Severity: normal
 262 Certainty: certain
 263 Info: The key on this line of the desktop entry has been deprecated in the
 264  FreeDesktop specification.
 265 Ref: http://standards.freedesktop.org/desktop-entry-spec/1.0/apc.html
 266
 267 Tag: desktop-entry-contains-encoding-key
 268 Severity: wishlist
 269 Certainty: certain
 270 Info: The Encoding key is now deprecated by the FreeDesktop standard and
 271  all strings are required to be encoded in UTF-8.  This desktop entry
 272  explicitly specifies an Encoding of UTF-8, which is harmless but no
 273  longer necessary.
 274 Ref: http://standards.freedesktop.org/desktop-entry-spec/1.0/apc.html
 275
 276 Tag: desktop-entry-lacks-main-category
 277 Severity: normal
 278 Certainty: certain
 279 Info: The categories for this desktop entry do not contain any Main
 280  Categories, only Additional Categories.  Additional Categories should
 281  only be used on conjunction with one or more Main Categories.
 282 Ref: http://standards.freedesktop.org/menu-spec/1.0/apa.html
 283
 284 Tag: desktop-entry-uses-reserved-category
 285 Severity: normal
 286 Certainty: certain
 287 Info: This desktop entry includes a Reserved Category, one which has a
 288  desktop-specific meaning that has not yet been standardized, but does not
 289  include an OnlyShowIn key.  Desktop entries using a Reserved Category
 290  must include an OnlyShowIn key limiting the entry to those environments
 291  that support the category.
 292 Ref: http://standards.freedesktop.org/menu-spec/1.0/apa.html
 293
 294 Tag: desktop-entry-invalid-category
 295 Severity: normal
 296 Certainty: certain
 297 Info: This desktop entry lists a category that is not one of the
 298  registered Main or Additional Categories in the FreeDesktop
 299  specification.
 300 Ref: http://standards.freedesktop.org/menu-spec/1.0/apa.html
 301
 302 Tag: desktop-command-not-in-package
 303 Severity: normal
 304 Certainty: possible
 305 Info: The desktop entry specifies a command that is not available in the
 306  package.  In most cases, this is a typo or a forgotten update of the
 307  desktop file after the install location of the binary was changed.  A
 308  desktop file for a command should be included in the same package as that
 309  command.
 310
 311 Tag: desktop-contains-deprecated-header
 312 Severity: normal
 313 Certainty: certain
 314 Info: The header on this line of the desktop entry has been deprecated in the
 315  FreeDesktop specification.  If the header is "KDE Desktop Entry", the right
 316  fix is normally changing it to "Desktop Entry".
 317 Ref: http://standards.freedesktop.org/desktop-entry-spec/1.0/apc.html
 318
 319 Tag: deprecated-kdelnk-file
 320 Severity: important
 321 Certainty: certain
 322 Info: kdelnk files were used by KDE 1 and since KDE 2 desktop files are used
 323  instead.  Renaming the file and removing the deprecated header and keys
 324  is often all that needs to be done.
 325 Ref: http://standards.freedesktop.org/desktop-entry-spec/1.0/apc.html