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

   1 Check-Script: description
   2 Author: Christian Schwarz <schwarz@debian.org>
   3 Abbrev: des
   4 Type: binary, udeb
   5 Unpack-Level: 1
   6
   7 Tag: package-has-no-description
   8 Type: error
   9 Info: The binary package does not have a "Description:" control field.
  10 Tested: empty
  11
  12 Tag: description-synopsis-is-empty
  13 Type: error
  14 Info: The first line in the "Description:" is empty.
  15
  16 Tag: extended-description-is-empty
  17 Type: error
  18 Status: untested
  19 Info: The extended description (the lines after the first line of the
  20  "Description:" field) is empty.
  21
  22 Tag: description-contains-invalid-control-statement
  23 Type: error
  24 Info: The description contains a line starting with a dot (.). This is
  25  not allowed.
  26 Ref: policy 5.6.13
  27
  28 Tag: description-too-long
  29 Type: error
  30 Info: The first line of the "Description:" must not exceed 80 characters.
  31 Ref: policy 3.4.1
  32
  33 Tag: description-synopsis-has-leading-spaces
  34 Type: error
  35 Status: untested
  36 Info: The first line of the "Description:" should not have leading spaces.
  37
  38 Tag: description-starts-with-package-name
  39 Type: error
  40 Info: The first line of the "Description:" should not start with the
  41  package name. For example, the package <tt>foo</tt> should not
  42  have a description like this: `foo is a program that...'.
  43 Ref: policy 3.4.1
  44
  45 Tag: description-contains-tabs
  46 Type: error
  47 Info: The package "Description:" must not contain tab characters.
  48 Ref: policy 5.6.13
  49
  50 Tag: description-starts-with-leading-spaces
  51 Type: warning
  52 Info: The package "Description:" starts with leading spaces. Usually,
  53  leading spaces are used to switch `verbatim display' on (i.e., lines
  54  are not wrapped) so this might be a bug in the package.
  55
  56 Tag: possible-unindented-list-in-extended-description
  57 Type: warning
  58 Info: The package "Description:" contains an unindented line which
  59  starts with a dash (-) or asterisk (*). If this was meant to be a
  60  list of items these lines need to be indented (dselect would
  61  word-wrap these lines otherwise).
  62 Ref: policy 5.6.13
  63
  64 Tag: description-is-debmake-template
  65 Type: error
  66 Info: The synopsis or the extended description just says "Missing",
  67  which is a template provided by debmake.
  68
  69 Tag: description-is-dh_make-template
  70 Type: error
  71 Info: The synopsis or the extended description has not been changed
  72  from the template provided by dh_make.
  73
  74 Tag: description-synopsis-might-not-be-phrased-properly
  75 Type: warning
  76 Info: The synopsis (first line in the package "Description:" field, the
  77  short description) ends with a full stop "." character. This is not
  78  necessary, as the synopsis doesn't need to be a full sentence. It is
  79  recommended that a descriptive phrase is used instead.
  80  .
  81  Note also that the synopsis is not part of the rest of the "Description:"
  82  field.
  83 Ref: policy 3.4.1
  84
  85 Tag: description-synopsis-is-duplicated
  86 Type: error
  87 Info: The first line of the extended Description: should not repeat the
  88  synopsis exactly. This indicates that either the synopsis is badly formed
  89  or that the extended description has been wrongly copied and pasted.
  90 Ref: policy 3.4.2
  91
  92 Tag: extended-description-line-too-long
  93 Type: warning
  94 Info: One or more lines in the extended part of the "Description:" field
  95  have been found to contain more than 80 characters. For the benefit of
  96  users of 80x25 terminals, it is recommended that the lines do not exceed
  97  80 characters.
  98 Ref: policy 3.4.1
  99
 100 Tag: description-contains-homepage
 101 Type: warning
 102 Info: The extended description contains a "Homepage:" pseudo-header
 103  following the old Developer's Reference recommendation.  As of 1.14.6,
 104  dpkg now supports Homepage: as a regular field in
 105  <tt>debian/control</tt>.  This header should be moved from the extended
 106  description to the fields for the relevant source or binary packages.
 107
 108 Tag: spelling-error-in-description
 109 Type: warning
 110 Info: Lintian found a spelling or capitalization error in the package
 111  description.  Lintian has a list of common misspellings that it looks
 112  for.  It does not have a dictionary like a spelling checker does.  It is
 113  particularly picky about spelling and capitalization in package
 114  descriptions since they're very visible to end users.
 115
 116 Tag: description-contains-duplicated-word
 117 Type: warning
 118 Info: The description contains a duplicated word.  Usually this is a
 119  mistake, or at least an awkward phrasing.