Re: Example of proposed pod usage (with patch)
On 2011-08-13 13:21, Jeremiah C. Foster wrote:
>> BTW, I committed your original README.developers with a few
>> > changes[1], so your patch would probably not apply cleanly.
> thanks for your changes, they clarify my draft text. I'll merge into my separate repo https://github.com/jeremiah/lintian-jeremiah-branch just so it is easier for me to follow. I'll still send patches to the list in the format suggested unless you'd rather pull?
>
I forgot to mention that I wrote a wiki page[1] that may help you (or
others).
~Niels
[1] https://wiki.debian.org/Teams/Lintian/HackersGuide
README for for Lintian developers
=================================
This file is intended for people, who wants to develop or work on
Lintian. For how to use Lintian, please refer to the README, the
manual pages lintian(1) and lintian-info(1) or the User Manaul.
The source code layout
----------------------
The source code is divided into self-contained groups. Here is a
quick overview:
checks - contains the checks and the tag descriptions.
collection - contains unpacking scripts
data - data sets used by checks via the Lintian::Data API
debian - contains Debian packaging
doc - contains the User Manuals and general docs (see man/ below)
frontend - contains the frontends (e.g. code installed in /usr/bin)
lib - Perl Modules/library for common tasks
man - contains the manpages for tools in frontend/
private - various private helpers etc.
profiles - contains vendor profiles
reporting - tools/code for the lintian.d.o setup
t - the new test suite
testset - the legacy test suite
unpack - deprecated; used to contain unpack tools (see collection above)
Core concepts in Lintian
------------------------
In Lintian there are a number of concepts (or terms), here is a list of the
most important ones:
Emit (Tag):
Tag that was not supressed and was triggered.
Lab(oratory):
The Laboratory is Lintian's private little play-ground. When
Lintian is asked to process a package, it will generally unpack
(parts of) the package in the laboratory. It comes in two
variants, static or temporary.
Temporary laboratories (as the name suggests) expire as soon as
Lintian is done with its tasks.
Static laboratories are generally used on lintian.d.o(-like)
setups, where packages remain in a (semi-)unpacked state after
processing.
Note that the laboratory is usually abbreviated to "Lab".
Overridden (Tag):
Tag that was overriden by the maintainer. Usually it means that
the maintainer believes Lintian misdiagnosed the issue. In some
cases it is also used for tags that does not handle "corner-cases"
Overriden tags are not displayed by default, but they are still
counted in statistics. This should not be confused with
"Suppressed".
Suppressed (Tag):
Tags that are suppressed cannot be emitted.
Note that suppressed tags are ignored by Lintian, so they are not
counted in statistics. Not to be confused with "Overriden".
Tag: Issue reported by Lintian.
Reply to: