/usr/share/doc/lintian/lintian.html/section-2.4.html is in lintian 2.5.43.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>Overrides</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="Lintian User's Manual"
HREF="index.html"><LINK
REL="UP"
TITLE="Getting started"
HREF="chapter-2.html"><LINK
REL="PREVIOUS"
TITLE="Lintian Tags"
HREF="section-2.3.html"><LINK
REL="NEXT"
TITLE="Vendor Profiles"
HREF="section-2.5.html"></HEAD
><BODY
CLASS="sect1"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>Lintian User's Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="section-2.3.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Chapter 2. Getting started</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="section-2.5.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="sect1"
><H1
CLASS="sect1"
><A
NAME="section-2.4"
>2.4. Overrides</A
></H1
><P
> In some cases, the checked package does not have a bug or does
not violate policy, but Lintian still reports an error or
warning. This can have the following reasons: Lintian has a
bug itself, a specific Lintian check is not smart enough to
know about a special case allowed by policy, or the policy
does allow exceptions to some rule in general.
</P
><P
> In the first case (where Lintian has a bug) you should send a
bug 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 <CODE
CLASS="option"
>-d</CODE
> (or <CODE
CLASS="option"
>--debug</CODE
>) 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.
</P
><P
> In the other two cases (where the error is actually an exception to
policy), you should probably add an override. If you're unsure though whether
it's indeed a good case for an override, you should contact the Lintian
maintainers too, including the Lintian error message and a short note, stating
why you think this is an exception. This way, the Lintian maintainers can be
sure the problem is not actually a bug in Lintian or an error in the author's
reading of policy. Please do not override bugs in lintian, they should rather
be fixed than overridden.
</P
><P
> Once it has been decided that an override is needed, you can easily add one by
supplying an overrides file. If the override is for a binary or udeb
package, you have to place it at
<TT
CLASS="filename"
>/usr/share/lintian/overrides/<TT
CLASS="replaceable"
><I
><package></I
></TT
></TT
>
inside the package. The tool <B
CLASS="command"
>dh_lintian</B
>
from the Debian
package <SPAN
CLASS="systemitem"
>debhelper</SPAN
> may
be useful for this purpose.
</P
><P
> If the override is for a source package, you have to place it
at <TT
CLASS="filename"
>debian/source/lintian-overrides</TT
>
or <TT
CLASS="filename"
>debian/source.lintian-overrides</TT
> (the
former path is preferred). With that, Lintian will know about
this exception and not report the problem again when checking
your package. (Actually, Lintian will report the problem
again, but with type <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>overridden</I
></SPAN
>, see
above.)
</P
><P
> Note that Lintian extracts the override file from the (u)deb
and stores it in the laboratory. The files currently installed
on the system are not used in current Lintian versions.
</P
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="section-2.4.1"
>2.4.1. Format of override files</A
></H2
><P
> The format of the overrides file is simple, it consists of one override per
line (and may contain empty lines and comments, starting with a <TT
CLASS="literal"
>#</TT
>, on others):
<TT
CLASS="literal"
>[[<TT
CLASS="replaceable"
><I
><package></I
></TT
>][ <TT
CLASS="replaceable"
><I
><archlist></I
></TT
>][ <TT
CLASS="replaceable"
><I
><type></I
></TT
>]: ]<TT
CLASS="replaceable"
><I
><lintian-tag></I
></TT
>[
[*]<TT
CLASS="replaceable"
><I
><lintian-info></I
></TT
>[*]]</TT
>. <TT
CLASS="replaceable"
><I
><package></I
></TT
> is the package name;
<TT
CLASS="replaceable"
><I
><archlist></I
></TT
> is an
architecture list (see Architecture specific overrides for
more info);
<TT
CLASS="replaceable"
><I
><type></I
></TT
> is one of <TT
CLASS="literal"
>binary</TT
>, <TT
CLASS="literal"
>udeb</TT
> and
<TT
CLASS="literal"
>source</TT
>,
and <TT
CLASS="replaceable"
><I
><lintian-info></I
></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:
</P
><PRE
CLASS="screen"
> /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
</PRE
><P
>An example file for a source package would look like:</P
><PRE
CLASS="screen"
> 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
</PRE
><P
> Many tags can occur more than once (e.g. if the same error is
found in more than one file). You can override a tag either
completely by specifying its name (first line in the examples)
or only one occurrence of it by specifying the additional
info, too (second line in the examples). If you add an
asterisk (<TT
CLASS="literal"
>*</TT
>) in the additional info, this
will match arbitrary strings similar to the shell wildcard.
</P
><P
> The first wildcard support appeared in Lintian 2.0.0, which
only allowed the wildcards in the very beginning or end.
Version 2.5.0~rc4 extended this to allow wildcards any where
in the additional info.
</P
></DIV
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="section-2.4.2"
>2.4.2. Documenting overrides</A
></H2
><P
> To assist reviewers, Lintian will extract the comments from
the overrides file and display the related comments next to
the overridden tags.
</P
><P
> Comments directly above an override will be shown next to all
tags it overrides. If an override for the same tags appears
on the very next line, it will inherit the comment from the
override above it.
</P
><PRE
CLASS="screen"
> # This comment will be shown above all tags overridden by the following
# two overrides, (because they apply to the same tag and there is no
# empty line between them)
foo source: some-tag exact match
foo source: some-tag wildcard * match
# This override has its own comment, and it is not shared with the
# override below (because there is an empty line in between them).
foo source: some-tag another exact match
foo source: some-tag override without a comment
</PRE
><P
> Empty lines can be used to disassociate a comment from an
override following it. This can also be used to make a general
comment about the overrides that will not be displayed.
</P
><PRE
CLASS="screen"
> # This is a general comment not connected to any override, since there
# is one (or more) empty lines after it.
foo source: another-tag without any comments
</PRE
></DIV
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="section-2.4.3"
>2.4.3. Architecture specific overrides</A
></H2
><P
> In rare cases, Lintian tags may be architecture specific.
It is possible to mark overrides architecture specific by
using the optional architecture list.
</P
><P
> The architecture list has the same syntax as the
architecture list in the "Build-Depends" field of a source
package. This is described in detail in the <A
HREF="https://www.debian.org/doc/debian-policy/ch-relationships.html#s-depsyntax"
TARGET="_top"
> Debian Policy Manual ยง7.1</A
>. Examples:
</P
><PRE
CLASS="screen"
> # This is an example override that only applies to the i386
# architecture.
foo [i386] binary: some-tag optional-extra
# An architecture wildcard would look like:
foo [any-i386] binary: another-tag optional-extra
# Negation also works
foo [!amd64 !i386] binary: some-random-tag optional-extra
# Negation even works for wildcards
foo [!any-i386] binary: some-tag-not-for-i386 optional-extra
# The package name and the package type is optional, so this
# also works
[linux-any]: tag-only-for-linux optional-extra.
</PRE
><P
> Support for architecture specific overrides was added in
Lintian 2.5.0. Wildcard support was added in 2.5.5. Basic
sanity checking was also added in 2.5.5, where unknown
architectures trigger
a <TT
CLASS="literal"
>malformed-override</TT
> tag. As does an
architecture specific override for architecture independent
packages.
</P
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="section-2.3.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="section-2.5.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Lintian Tags</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="chapter-2.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Vendor Profiles</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
|