lintian: r354 - in trunk: debian doc

[jeroen@wolffelaar.nl]

Author: jeroen
Date: 2004-10-13 02:30:02 +0200 (Wed, 13 Oct 2004)
New Revision: 354

Modified:
   trunk/debian/changelog
   trunk/doc/lintian.sgml
Log:
doc/lintian.sgml:
+ [JvW] Document that you can use comments in overrides (Closes: #87805)


Modified: trunk/debian/changelog
===================================================================
--- trunk/debian/changelog	2004-10-13 00:26:11 UTC (rev 353)
+++ trunk/debian/changelog	2004-10-13 00:30:02 UTC (rev 354)
@@ -43,6 +43,9 @@
   * checks/shared-libraries:
     + [JvW] Ignore comments in shlibs files (Closes: #275124)
 
+  * doc/lintian.sgml:
+    + [JvW] Document that you can use comments in overrides (Closes: #87805)
+
   * frontend/lintian:
     + [JvW] Fix overrides so that they allow all of (1) <package> <type>:, (2)
       <package>:, and (3) <nothing> as prefix to tags you want to override,

Modified: trunk/doc/lintian.sgml
===================================================================
--- trunk/doc/lintian.sgml	2004-10-13 00:26:11 UTC (rev 353)
+++ trunk/doc/lintian.sgml	2004-10-13 00:30:02 UTC (rev 354)
@@ -446,16 +446,21 @@
 
 <p>
 
-The format of the overrides file is simple: <tt>[&lt;package&gt;[
-&lt;type&gt;]: ]&lt;lintian-tag&gt;[ &lt;lintian-info&gt;]</tt>. 
-<tt>&lt;package&gt;</tt> is the package name; <tt>&lt;type&gt;</tt>
-is one of <tt>binary</tt>, <tt>udeb</tt> and <tt>source</tt>, and
-<tt>&lt;lintian-info&gt;</tt> is all additional information provided
-by Lintian except for the tag. What's inside brackets is optional and may be
-omitted if you want to match it all.
-An example file for a binary package would look like:
+The format of the overrides file is simple, it consists of one override per
+line (and may contain empty lines and comments, staring with a #, on others):
+<tt>[&lt;package&gt;[ &lt;type&gt;]: ]&lt;lintian-tag&gt;[
+&lt;lintian-info&gt;]</tt>.  <tt>&lt;package&gt;</tt> is the package name;
+<tt>&lt;type&gt;</tt> is one of <tt>binary</tt>, <tt>udeb</tt> and
+<tt>source</tt>, and <tt>&lt;lintian-info&gt;</tt> is all additional
+information provided by Lintian except for the tag. What's inside brackets is
+optional and may be omitted if you want to match it all.  An example file for
+a binary package would look like:
+
 <example>
 /usr/share/lintian/overrides/foo, where foo is the name of your package
+
+# We use a non-standard dir permission to only allow the webserver to look
+# into this directory:
 foo binary: non-standard-dir-perm
 foo binary: FSSTND-dir-in-usr /usr/man/man1/foo.1.gz
 </example>
@@ -466,6 +471,8 @@
 <example>
 debian/source.lintian-overrides in your base source directory
 foo source: debian-files-list-in-source
+# Upstream distributes it like this, repacking would be overkill though, so
+# tell lintian to not complain:
 foo source: configure-generated-file-in-source config.cache
 </example>