2 Author: Christian Schwarz <schwarz@debian.org>
6 Needs-Info: doc-base-files
8 Tag: postinst-should-not-set-usr-doc-link
11 Info: The technical committee chose the symlink transition method to move
12 from FSSTND to FHS. That transition has been completed with woody and thus
13 this link is no longer required.
15 Tag: maintainer-script-does-not-check-for-existence-of-updatemenus
18 Info: The maintainer script calls the <tt>update-menus</tt> command without
19 checking for existence first. (The <tt>menu</tt> package which provides the
20 command is not marked as "essential" package.)
22 For example, use the following code in your maintainer script:
23 if [ -x /usr/bin/update-menus ] ; then update-menus ; fi
25 Tag: maintainer-script-does-not-check-for-existence-of-wm-menu-config
28 Info: The maintainer script calls the <tt>wm-menu-config</tt> command without
29 checking for existence first. (The <tt>menu</tt> package which provides
30 the command is not marked as "essential" package.)
32 For example, use the following code in your maintainer script:
33 if [ -x /usr/sbin/wm-menu ]; then /usr/sbin/wm-menu-config; fi
35 Tag: maintainer-script-does-not-check-for-existence-of-installdocs
38 Info: The maintainer script calls the <tt>install-docs</tt> command without
39 checking for existence first. (The <tt>doc-base</tt> package which provides
40 the command is not marked as "essential" package.)
42 For example, use the following code in your maintainer script:
43 if [ -x /usr/sbin/install-docs ]; then
44 /usr/sbin/install-docs -i /usr/share/doc-base/<your-package>
47 Tag: maintainer-script-calls-deprecated-wm-menu-config
50 Info: The use of the wm-menu-config script is deprecated because its design
51 had some serious flaws.
54 Tag: preinst-calls-updatemenus
57 Info: The preinst script calls the <tt>update-menus</tt> command. Usually,
58 this command should be called from the <tt>postinst</tt> maintainer script.
60 Tag: preinst-calls-installdocs
63 Info: The preinst script calls the <tt>install-docs</tt> command. Usually,
64 this command should be called from the <tt>postinst</tt> maintainer script.
66 Tag: prerm-calls-updatemenus
69 Info: The prerm script calls the <tt>update-menus</tt> command. Usually,
70 this command should be called from the <tt>postrm</tt> maintainer script.
72 Tag: postrm-calls-installdocs
75 Info: The postrm script calls the <tt>install-docs</tt> command. Usually,
76 this command should be called from the <tt>prerm</tt> maintainer script.
78 Tag: executable-menu-file
81 Info: Menu files should normally not be marked as executables. You only
82 need to do this if your package has to generate menu entries dynamically.
84 Tag: menu-file-in-usr-lib
87 Info: As of menu, version 2.1.25, /usr/lib/menu as location for menu
88 files is deprecated (but still works perfectly). Menu files should
89 now be placed in /usr/share/menu instead. Only menu files that are
90 actually binary executables still need to go to /usr/lib/menu.
93 Tag: executable-in-usr-share-docbase
96 Info: Files in <tt>/usr/share/doc-base</tt> may not be marked as executables.
98 Tag: postinst-does-not-call-updatemenus
101 Info: Since the package installs a file in <tt>/etc/menu-methods</tt>,
102 <tt>/usr/share/menu</tt>, or <tt>/usr/lib/menu</tt>, the package should
103 probably call the <tt>update-menus</tt> command in it's <tt>postinst</tt>
106 For example, use the following code in your maintainer script:
107 if [ -x /usr/bin/update-menus ] ; then update-menus ; fi
110 Tag: postrm-does-not-call-updatemenus
113 Info: Since the package installs a file in <tt>/etc/menu-methods</tt>,
114 <tt>/usr/share/menu</tt>, or <tt>/usr/lib/menu</tt>, the package should
115 probably call the <tt>update-menus</tt> command in it's <tt>postrm</tt>
118 For example, use the following code in your maintainer script:
119 if [ -x /usr/bin/update-menus ] ; then update-menus ; fi
122 Tag: postinst-has-useless-call-to-update-menus
125 Info: The <tt>postinst</tt> script calls the <tt>update-menus</tt> program
126 though no file is installed in <tt>/etc/menu-methods</tt>,
127 <tt>/usr/share/menu</tt>, or <tt>/usr/lib/menu</tt>.
129 Tag: postrm-has-useless-call-to-update-menus
132 Info: The <tt>postrm</tt> script calls the <tt>update-menus</tt> program
133 though no file is installed in <tt>/etc/menu-methods</tt>,
134 <tt>/usr/share/menu</tt>, or <tt>/usr/lib/menu</tt>.
136 Tag: postinst-has-useless-call-to-install-docs
139 Info: Explicitly calling <tt>install-docs</tt> in <tt>postinst</tt> is no
140 longer required since doc-base file processing is handled by triggers.
141 If the <tt>install-docs</tt> call was added by debhelper, rebuilding the
142 package with debhelper 7.2.3 or later will fix this problem.
144 Tag: prerm-has-useless-call-to-install-docs
147 Info: Explicitly calling <tt>install-docs</tt> in <tt>prerm</tt> is no
148 longer required since doc-base file processing is handled by triggers.
149 If the <tt>install-docs</tt> call was added by debhelper, rebuilding the
150 package with debhelper 7.2.3 or later will fix this problem.
152 Tag: bad-menu-file-name
155 Info: The package installs a file <tt>/usr/lib/menu/menu</tt>, which is
156 already in use by the <tt>menu</tt> package itself. The menu file should
157 be named after the package that installs it.
159 Tag: doc-base-file-references-usr-doc
162 Info: Files in <tt>/usr/share/doc-base</tt> should only contain links to
163 files in the <tt>/usr/share/doc</tt> directory.
165 Tag: doc-base-index-references-multiple-files
168 Info: The Index field in a doc-base file should reference the single index
169 file for that document. Any other files belonging to the same document
170 should be listed in the Files field.
171 Ref: doc-base 2.3.2.2
173 Tag: doc-base-file-references-missing-file
176 Info: One of the files referenced in an Index or Files field in this
177 doc-base control file does not exist in the package. The doc-base
178 control files should be installed by the package that provides the
179 documents they are registering.
181 Tag: doc-base-file-unknown-format
184 Info: The Format field in this doc-base control file declares a format
185 that is not supported. Recognized formats are "HTML", "Text", "PDF",
186 "PostScript", "Info", "DVI", and "DebianDoc-SGML" (case-insensitive).
187 Ref: doc-base 2.3.2.2
189 Tag: doc-base-file-no-format
192 Info: A format section of this doc-base control file didn't specify a
193 format. Each section after the first must specify a format.
194 Ref: doc-base 2.3.2.2
196 Tag: doc-base-file-no-format-section
199 Info: This doc-base control file didn't specify any format
201 Ref: doc-base 2.3.2.2
203 Tag: doc-base-file-no-index
206 Info: Format sections in doc-base control files for HTML or Info documents
207 must contain an Index field specifying the starting document for the
208 documentation. Even if the documentation is a single file, this field
210 Ref: doc-base 2.3.2.2
212 Tag: doc-base-document-field-ends-in-whitespace
215 Info: The Document field in a doc-base file should not end in whitespace.
216 doc-base (at least as of 0.8.5) cannot cope with such fields and
217 debhelper 5.0.57 or earlier may create files ending in whitespace when
218 installing such files.
220 Tag: doc-base-document-field-not-in-first-line
223 Info: The Document field in doc-base control file must be located at
224 first line of the file. While unregistering documents, doc-base 0.8
225 and later parses only the first line of the control file for performance
227 Ref: doc-base 2.3.2.1
229 Tag: doc-base-file-unknown-field
232 Info: The doc-base control file contains field which is either unknown
233 or not valid for the section where was found. Possible reasons for this
234 error are: a typo in field name, missing empty line between control file
235 sections, or an extra empty line separating sections.
236 Ref: doc-base 2.3.2.1, doc-base 2.3.2.2
238 Tag: doc-base-file-duplicated-field
241 Info: The doc-base control file contains a duplicated field.
243 Tag: doc-base-file-duplicated-format
246 Info: The doc-base control file contains a duplicated format. Doc-base
247 files must not register different documents in one control file.
248 Ref: doc-base 2.3.2.2
250 Tag: doc-base-file-lacks-required-field
253 Info: The doc-base control file does not contain a required field for the
255 Ref: doc-base 2.3.2.1, doc-base 2.3.2.2
257 Tag: doc-base-invalid-document-field
260 Info: The Document field should consists only of letters (a-z), digits
261 (0-9), plus (+) or minus (-) signs, and dots (.). In particular,
262 uppercase letters are not allowed.
265 Tag: doc-base-abstract-field-is-template
268 Info: The Abstract field of doc-base contains a "manage online manuals"
269 phrase, which was copied verbatim from an example control file found in
270 section 2.3.1 of the Debian doc-base Manual.
272 Tag: doc-base-abstract-might-contain-extra-leading-whitespaces
275 Info: Continuation lines of the Abstract field of doc-base control file
276 should start with only one space unless they are meant to be displayed
277 verbatim by frontends.
280 Tag: doc-base-abstract-field-separator-extra-whitespaces
283 Info: Unnecessary spaces were found in the paragraph separator line of the
284 doc-base's Abstract field. The separator line should consist of a single
285 space followed by a single dot.
288 Tag: spelling-error-in-doc-base-title-field
291 Info: Maemian found a spelling or capitalization error in the Title field
292 of this doc-base control file. Maemian has a list of common misspellings
293 that it looks for. It does not have a dictionary like a spelling checker
296 Tag: spelling-error-in-doc-base-abstract-field
299 Info: Maemian found a spelling or capitalization error in the Abstract
300 field of this doc-base control file. Maemian has a list of common
301 misspellings that looks for. It does not have a dictionary like a
302 spelling checker does.
304 Tag: doc-base-file-syntax-error
307 Info: Maemian found a syntax error in the doc-base control file.
308 Ref: doc-base 2.3.2.2
310 Tag: doc-base-file-separator-extra-whitespaces
313 Info: Unnecessary spaces were found in the doc-base file sections'
314 separator. The section separator is an empty line and should not contain
318 Tag: doc-base-file-uses-obsolete-national-encoding
321 Info: doc-base files must be valid UTF-8, an encoding of the Unicode
324 There are many ways to convert a doc-base file from an obsolete encoding
325 like ISO-8859-1. You may, for example, use "iconv" like:
327 $ iconv -f ISO-8859-1 -t UTF-8 doc-base > doc-base.new
328 $ mv doc-base.new doc-base
331 Tag: doc-base-uses-applications-section
334 Info: The section indicated in this doc-base control file has a top-level
335 section of Apps or Applications. This section is only used in menu, not
336 in doc-base. Simply removing the top-level section will lead to a valid
340 Tag: doc-base-unknown-section
343 Info: The section indicated in this doc-base control file is not one of
344 the standard doc-base sections. The doc-base sections are based on the
345 menu sections but are not exactly the same.
348 Tag: menu-method-should-include-menu-h
351 Info: A menu-method file must include the menu.h configuration file
352 (using "!include menu.h").