lintian: r162 - in trunk: debian doc
Author: djpig
Date: 2004-04-15 22:35:27 +0200 (Thu, 15 Apr 2004)
New Revision: 162
Removed:
trunk/doc/TODO
Modified:
trunk/debian/changelog
trunk/doc/README
trunk/doc/desc-files
trunk/doc/lintian.sgml
Log:
Bring the documentation (somewhat) up-to-date
Modified: trunk/debian/changelog
===================================================================
--- trunk/debian/changelog 2004-04-15 19:13:24 UTC (rev 161)
+++ trunk/debian/changelog 2004-04-15 20:35:27 UTC (rev 162)
@@ -19,6 +19,11 @@
+ [HE] Added a --dont-check-parts|-X option to allow users to specify
which tests should not be run. Also added infos about this to the
manpage. (Closes: #206674)
+
+ * doc/lintian.sgml:
+ + [FL] Some updates, some more verbatim explantions
+ * doc/README:
+ + [FL] Update options
* checks/binaries:
+ [JvW] Ignore static binaries in /usr/lib/debug
Modified: trunk/doc/README
===================================================================
--- trunk/doc/README 2004-04-15 19:13:24 UTC (rev 161)
+++ trunk/doc/README 2004-04-15 20:35:27 UTC (rev 162)
@@ -40,6 +40,7 @@
2. Run lintian over your packages:
$ lintian <something>.deb
+ $ lintian <something>.udeb
$ lintian <something>.dsc
$ lintian <something>.changes
@@ -53,30 +54,43 @@
(Please refer to the manual page lintian(1) for details.)
- actions:
+ Actions:
-S, --setup-lab set up static lab
- -R, --removed-lab remove static lab
+ -R, --remove-lab remove static lab
-c, --check check packages (default action)
-C X, --check-part X check only certain aspects
+ -X X, --dont-check-part X don't check certain aspects
-u, --unpack only unpack packages in the lab
- -U X, --unpack-info X only unpack and collect some info
-r, --remove remove package from the lab
-
- general options:
+ General options:
-h, --help display short help text
-v, --verbose verbose messages
-V, --version display Lintian version and exit
-d, --debug turn Lintian's debug messages ON
-
- configuration options:
+ --print-version print unadorned version number and exit
+ Behaviour options:
-i, --info give detailed info about tags
+ -I, --display-info display "I:" tags (normally suppressed)
-l X, --unpack-level X set default unpack level to X
-o, --no-override ignore overrides
-
- package selection options:
+ --show-overrides output tags that have been overriden
+ -U X, --unpack-info X specify which info should be collected
+ -m, --md5sums check md5sums when processing a .changes file
+ --allow-root suppress lintian's warning when run as root
+ Configuration options:
+ --cfg CONFIGFILE read CONFIGFILE for configuration
+ --lab LABDIR use LABDIR as permanent laboratory
+ --archivedir ARCHIVEDIR location of Debian archive to scan for packages
+ --dist DIST scan packages in this distribution (e.g. sid)
+ --section RELEASE scan packages in this section (e.g. main)
+ --arch ARCH scan packages with architecture ARCH
+ --root ROOTDIR use ROOTDIR instead of /usr/share/lintian
+ Package selection options:
-a, --all process all packages in distribution
-b, --binary process only binary packages
-s, --source process only source packages
+ --udeb process only udeb packages
+ -p X, --packages-file X process all files in file (special syntax!)
Where to find more information
@@ -106,3 +120,4 @@
Christian Schwarz <schwarz@debian.org>, Mar 14, 1998.
+Updated by Frank Lichtenheld, Apr 14, 2004 (Lintian 1.23.0).
Deleted: trunk/doc/TODO
===================================================================
--- trunk/doc/TODO 2004-04-15 19:13:24 UTC (rev 161)
+++ trunk/doc/TODO 2004-04-15 20:35:27 UTC (rev 162)
@@ -1,3 +0,0 @@
-Add testset for perl policy
-Add testset for helper-templates-in-copyright
-Add test for dpkg -r calls
\ No newline at end of file
Modified: trunk/doc/desc-files
===================================================================
--- trunk/doc/desc-files 2004-04-15 19:13:24 UTC (rev 161)
+++ trunk/doc/desc-files 2004-04-15 20:35:27 UTC (rev 162)
@@ -3,7 +3,7 @@
Collector-Script: <file name of collector script>
Info: <description of what this script does>
- Type: <binary | source>
+ Type: comma-separated list of <binary | source | udeb>
Unpack-Level: <1 | 2>
Output: <a file that's generated by this script>
Order: <order--necessary if this script needs info from other scripts, see Needs-Info>
@@ -14,7 +14,7 @@
Check-Script: <file name of checker script>
Abbrev: <abbrev>
Info: <description of what this check does>
- Type: <binary | source | binary, source>
+ Type: comma-separated list of <binary | source | udeb>
Standards-Version: <standards-version for which this check has been designed>
Unpack-Level: <1 | 2>
Needs-Info: <info this script needs>
Modified: trunk/doc/lintian.sgml
===================================================================
--- trunk/doc/lintian.sgml 2004-04-15 19:13:24 UTC (rev 161)
+++ trunk/doc/lintian.sgml 2004-04-15 20:35:27 UTC (rev 162)
@@ -6,8 +6,9 @@
<author>Christian Schwarz <email>schwarz@debian.org</email>
<author>Richard Braakman <email>dark@xs4all.nl</email>
<author>Sean 'Shaleh' Perry <email>shaleh@debian.org</email>
+<author>Frank Lichtenheld <email>djpig@debian.org</email>
<author>Contact address: <email>lintian-maint@debian.org</email>
-<version>version 0.3.3, 6 September 2000
+<version>version 1.23.0, 15 April 2004
<abstract>
This manual describes Lintian, the Debian package checker.
@@ -15,6 +16,7 @@
<copyright>Copyright © 1998 Christian Schwarz and Richard Braakman
Copyright © 2000 Sean 'Shaleh' Perry
+ Copyright © 2004 Frank Lichtenheld
<p>
This manual is free software; you may redistribute it and/or
@@ -261,8 +263,7 @@
<p>
Before you can start to check your packages with Lintian, you'll have
-to install the <prgn>lintian</prgn> Debian package. With Lintian version
-0.3.0, you don't need a configuration file in order to check packages.
+to install the <prgn>lintian</prgn> Debian package.
<p>
@@ -270,7 +271,7 @@
<p>
-After that, you can run Lintian over any Debian binary or source packages
+After that, you can run Lintian over any Debian binary, udeb or source packages
like this:
<p>
@@ -312,8 +313,13 @@
<p>
<tag><em>Warnings (W)</em>
-<item>The displayed message might be a policy violation or packaging error.
+<item>The displayed message might be a policy violation or packaging
+error. A warnings is usually an indication that the test is
+known to sometimes produce false positive alarms, because either
+the corresponding rule in policy has many exceptions or the test
+uses some sort of heuristic to find errors.
+
<p>
<tag><em>Info (I)</em>
@@ -343,7 +349,8 @@
<tag><em>Overridden (O)</em>
<item>The displayed message indicates a previous
<em>Warning</em> or <em>Error</em> message which has been
-<em>overridden</em> (see below).
+<em>overridden</em> (see below). They are not displayed unless
+the <tt>--show-overrides</tt> option is set.
<p>
@@ -407,7 +414,8 @@
report to the Debian bug tracking system and describe which package
you checked, which messages have been displayed, and why you think
Lintian has a bug. Best would be, if you would run Lintian again over
-your packages using the <tt>-d</tt> option, which will cause Lintian to
+your packages using the <tt>-d</tt> (or <tt>--debug</tt>) option,
+which will cause Lintian to
output much more information (debugging info), and include these
messages in your bug report. This will simplify the debugging process
for the authors of Lintian.
@@ -426,16 +434,31 @@
<p>
-The format of the overrides file is simple: package: lintian-message.
+Note that Lintian extracts the override file from the deb and stores
+it in the laboratory. The files currently installed on the system are
+not used in current Lintian versions.
+
+<p>
+
+The format of the overrides file is simple: <tt>package:
+lintian-tag lintian-info</tt> (lintian-info is optional).
An example file would look like:
<example>
/usr/share/lintian/overrides/foo, where foo is the name of your package
-foo: FSSTND-dir-in-usr
+foo: FSSTND-dir-in-usr /usr/man/man1/foo.1.gz
foo: non-standard-dir-perm
</example>
<p>
+Many tags can occour more than once (e.g. if the same error is found
+in more than one file. You can override a tag either completly by
+specifying its name (second line in the example) or only one
+occourence of it by specifying the additional info, too (first line
+in the example).
+
+<p>
+
<chapt>Advanced usage
<p>
@@ -592,8 +615,13 @@
deb (symlink to actual file)
unpacked/ (opt., contains unpacked binary package)
+ udeb/
+ <udeb-pkg-name>/
+ ... (same structure as for binary packages)
+
info/
binary-packages list of binary packages in archive
+ udeb-packages list of udeb packages in archive
source-packages list of source packages in archive
</example>
Reply to: