Bug#838195: lintian: Check for PACKAGE.maintscript files that include "maint-script-parameters".
Hi Niels,
Thanks for the review. :)
> The only thing I can thing I can think of would be a very minor nitpick
> about only matching exactly one space after "--" (instead of 1 or more).
Updated patch attached. It also matches "$@" and "${@}" for good measure,
and I've expanded the tests to match.
Regards,
--
,''`.
: :' : Chris Lamb
`. `'` lamby@debian.org / chris-lamb.co.uk
`-
>From 20b477392929dc2838a302386598f34ed3361a7c Mon Sep 17 00:00:00 2001
From: Chris Lamb <lamby@debian.org>
Date: Sun, 18 Sep 2016 23:26:02 +0100
Subject: [PATCH] Check for PACKAGE.maintscript files that include
"maint-script-parameters".
---
checks/debhelper.desc | 8 ++++++++
checks/debhelper.pm | 10 ++++++++++
.../debian/debian/maintscript | 4 ++++
t/tests/maintscript-includes-maint-script-parameters/desc | 6 ++++++
t/tests/maintscript-includes-maint-script-parameters/tags | 3 +++
5 files changed, 31 insertions(+)
create mode 100644 t/tests/maintscript-includes-maint-script-parameters/debian/debian/maintscript
create mode 100644 t/tests/maintscript-includes-maint-script-parameters/desc
create mode 100644 t/tests/maintscript-includes-maint-script-parameters/tags
diff --git a/checks/debhelper.desc b/checks/debhelper.desc
index 9b9d046..3317d56 100644
--- a/checks/debhelper.desc
+++ b/checks/debhelper.desc
@@ -361,3 +361,11 @@ Info: The listed target in debian/rules command is a likely misspelling.
Implementation detail: The typo is detected by using "Levenshtein
edit distance". Therefore, if the typo involve several characters,
Lintian may not detect it.
+
+Tag: maintscript-includes-maint-script-parameters
+Severity: normal
+Certainty: possible
+Info: Lines in a <tt>debian/*.maintscript</tt> correspond to
+ <tt>dpkg-maintscript-helper(1)</tt> commands and parameters. However, the
+ "maint-script-parameters" should not be included as debhelper will add those
+ automatically. See <tt>dh_installdeb(1)</tt> for more information.
diff --git a/checks/debhelper.pm b/checks/debhelper.pm
index ad80fc8..6cbfb58 100644
--- a/checks/debhelper.pm
+++ b/checks/debhelper.pm
@@ -354,6 +354,16 @@ sub run {
_tag_if_executable($file);
} elsif ($basename =~ m/^ex\.|\.ex$/i) {
tag 'dh-make-template-in-source', $file;
+ } elsif ($basename =~ m/^(?:(.*)\.)?maintscript$/) {
+ next unless $file->is_open_ok;
+ my $fd = $file->open;
+ while (<$fd>) {
+ if (m/--\s+"\$(?:@|{@})"\s*$/) {
+ tag 'maintscript-includes-maint-script-parameters',
+ $basename, "(line $.)";
+ }
+ }
+ close($fd);
} elsif ($basename =~ m/^(?:.+\.)?debhelper(?:\.log)?$/){
# The regex matches "debhelper", but debhelper/Dh_Lib does not
# make those, so skip it.
diff --git a/t/tests/maintscript-includes-maint-script-parameters/debian/debian/maintscript b/t/tests/maintscript-includes-maint-script-parameters/debian/debian/maintscript
new file mode 100644
index 0000000..6a583d7
--- /dev/null
+++ b/t/tests/maintscript-includes-maint-script-parameters/debian/debian/maintscript
@@ -0,0 +1,4 @@
+rm_conffile /etc/correct.conf 0.2~ foo
+rm_conffile /etc/incorrect.conf 0.2~ foo -- "$@"
+rm_conffile /etc/incorrect.conf 0.2~ foo -- "${@}"
+rm_conffile /etc/incorrect.conf 0.2~ foo -- "$@"
diff --git a/t/tests/maintscript-includes-maint-script-parameters/desc b/t/tests/maintscript-includes-maint-script-parameters/desc
new file mode 100644
index 0000000..0313ac0
--- /dev/null
+++ b/t/tests/maintscript-includes-maint-script-parameters/desc
@@ -0,0 +1,6 @@
+Testname: maintscript-includes-maint-script-parameters
+Sequence: 6000
+Version: 1.0
+Description: Check for dh_installdeb .maintscript files
+Test-For:
+ maintscript-includes-maint-script-parameters
diff --git a/t/tests/maintscript-includes-maint-script-parameters/tags b/t/tests/maintscript-includes-maint-script-parameters/tags
new file mode 100644
index 0000000..088f8c3
--- /dev/null
+++ b/t/tests/maintscript-includes-maint-script-parameters/tags
@@ -0,0 +1,3 @@
+W: maintscript-includes-maint-script-parameters source: maintscript-includes-maint-script-parameters maintscript (line 2)
+W: maintscript-includes-maint-script-parameters source: maintscript-includes-maint-script-parameters maintscript (line 3)
+W: maintscript-includes-maint-script-parameters source: maintscript-includes-maint-script-parameters maintscript (line 4)
--
2.9.3
Reply to: