[lintian] 01/01: lintian.pod.in: Improve --(default-)display-level documentation
This is an automated email from the git hooks/post-receive script.
nthykier pushed a commit to branch master
in repository lintian.
commit 1f4c5f90b3ba767bde58d2e3a34bc410d4b7455b
Author: Niels Thykier <niels@thykier.net>
Date: Sat Dec 26 17:58:22 2015 +0000
lintian.pod.in: Improve --(default-)display-level documentation
Signed-off-by: Niels Thykier <niels@thykier.net>
---
debian/changelog | 4 ++++
man/lintian.pod.in | 57 +++++++++++++++++++++++++++++++++++++++++++++++++-----
2 files changed, 56 insertions(+), 5 deletions(-)
diff --git a/debian/changelog b/debian/changelog
index 0590d65..ef88fb9 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -16,6 +16,10 @@ lintian (2.5.40) UNRELEASED; urgency=medium
* man/lintian.pod.in:
+ [NT,JW] Document clarify that "-L +=<value>" is valid.
(Closes: #802729)
+ + [NT] Attempt to document --display-level a bit more extensively.
+ Thanks to Matt Zagrabelny for the report. (Closes: #802725)
+ + [NT] Clarify what --default-display-level does and why one might
+ want to use it.
* private/refresh-ftp-master-tags:
+ [JW] Use HTTPS for the ftp-master.debian.org URL.
diff --git a/man/lintian.pod.in b/man/lintian.pod.in
index bd91887..16fe167 100644
--- a/man/lintian.pod.in
+++ b/man/lintian.pod.in
@@ -190,12 +190,19 @@ This option overrides the B<color> variable in the configuration file.
=item B<--default-display-level>
-Reset the current display level to the default. This option behaves
-exactly like passing B<-L> ">=important" B<-L> "+>=normal/possible"
-B<-L> "+minor/certain" to lintian.
+Reset the current display level to the default. Basically, this
+option behaves exactly like passing the following options to lintian:
-One use for this option is to override only the display settings in
-the config file.
+ B<-L> ">=important" B<-L> "+>=normal/possible" B<-L> "+minor/certain"
+
+The primary use for this is to ensure that lintian's display level has
+been reset to the built-in default values. Notably, this can be used
+to override display settings earlier on the command-line or in the
+lintian configuration file.
+
+Further changes to the display level can be done I<after> this option.
+Example: B<--default-display-level --display-info> gives you the
+default display level plus informational ("I:") tags.
=item B<--display-source> X
@@ -258,6 +265,46 @@ serious, important, normal, minor, wishlist, pedantic), a certainty
settings are equivalent to B<-L> ">=important" B<-L>
"+>=normal/possible" B<-L> "+minor/certain").
+The value consists of 3 parts, where two of them are optional. The
+parts are:
+
+=over 4
+
+=item modifier operator
+
+How to affect the current display level. Can be one of add to ("+"),
+remove from ("-") or set to ("=") the display level(s) denoted by the
+following selection.
+
+The default value is "=" (i.e. set the display level).
+
+=item set operator
+
+The set of severity and certainties to be selected. The operator can
+be one of ">=", ">", "=", "<" or "<=". As an example, this can be used
+to select all important (or "more severe") tags via ">=important".
+
+The selected values includes only items where I<both> the severity and
+the certainty are both included in the set.
+
+As an example, ">=important/possible" includes "important/possible",
+"important/certain", "serious/possible" and "serious/certain". Note
+that it does I<not> include "serious/wild-guess" (since it does not
+satisfy the lower-bound for the certainty).
+
+The default value is "=", which means "exactly" the given severity
+or/and certainty.
+
+=item severity-certainty
+
+The severity or/and certainty. This can be any of the 3 forms:
+I<severity>, I<certainty> or I<severity>/I<certainty>.
+
+If only a severity or a certainty is given, the other one defaults to
+"any" as in "any certainty with the given severity" (or vice versa).
+
+=back
+
This option overrides the B<display-level> variable in the
configuration file. The value of the B<display-level> in
configuration file should be space separated entries in the same
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/lintian/lintian.git
Reply to: