diff mbox series

utils/checkpackagelib/lib_mk.py: handle 'else' and 'elif' statements

Message ID 20201209153219.17253-1-patrickdepinguin@gmail.com
State Accepted
Headers show
Series utils/checkpackagelib/lib_mk.py: handle 'else' and 'elif' statements | expand

Commit Message

Thomas De Schampheleire Dec. 9, 2020, 3:32 p.m. UTC
From: Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>

An 'else' or 'elif' clause inside a make conditional should not be indented
in the same way as the if/endif clause. check-package did not recognize the
else statement and expected an indentation.

For example:

ifdef FOOBAR
	interesting
else
	more interesting
endif

would, according to check-package, need to become:

ifdef FOOBAR
	interesting
	else
	more interesting
endif

Treat 'else' and 'elif' the same as if-like keywords in the Indent test, but
take into account that 'else' is also valid shell, so we need to correctly
handle line continuation to prevent complaining about the 'else' in:

ifdef FOOBAR
	if true; \
	    ... \
	else \
	    ... \
	fi
endif

We don't add the 'else' and 'elif' statements to start_conditional, because
it would cause incorrect nesting counting in class OverriddenVariable.

Signed-off-by: Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
---
 utils/checkpackagelib/lib_mk.py | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

Comments

Thomas Petazzoni Jan. 2, 2021, 12:55 p.m. UTC | #1
On Wed,  9 Dec 2020 16:32:18 +0100
Thomas De Schampheleire <patrickdepinguin@gmail.com> wrote:

> From: Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
> 
> An 'else' or 'elif' clause inside a make conditional should not be indented
> in the same way as the if/endif clause. check-package did not recognize the
> else statement and expected an indentation.
> 
> For example:
> 
> ifdef FOOBAR
> 	interesting
> else
> 	more interesting
> endif
> 
> would, according to check-package, need to become:
> 
> ifdef FOOBAR
> 	interesting
> 	else
> 	more interesting
> endif
> 
> Treat 'else' and 'elif' the same as if-like keywords in the Indent test, but
> take into account that 'else' is also valid shell, so we need to correctly
> handle line continuation to prevent complaining about the 'else' in:
> 
> ifdef FOOBAR
> 	if true; \
> 	    ... \
> 	else \
> 	    ... \
> 	fi
> endif
> 
> We don't add the 'else' and 'elif' statements to start_conditional, because
> it would cause incorrect nesting counting in class OverriddenVariable.
> 
> Signed-off-by: Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
> ---
>  utils/checkpackagelib/lib_mk.py | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)

Applied to master, thanks.

Thomas
Peter Korsgaard Jan. 5, 2021, 9:50 p.m. UTC | #2
>>>>> "Thomas" == Thomas De Schampheleire <patrickdepinguin@gmail.com> writes:

 > From: Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
 > An 'else' or 'elif' clause inside a make conditional should not be indented
 > in the same way as the if/endif clause. check-package did not recognize the
 > else statement and expected an indentation.

 > For example:

 > ifdef FOOBAR
 > 	interesting
 > else
 > 	more interesting
 > endif

 > would, according to check-package, need to become:

 > ifdef FOOBAR
 > 	interesting
 > 	else
 > 	more interesting
 > endif

 > Treat 'else' and 'elif' the same as if-like keywords in the Indent test, but
 > take into account that 'else' is also valid shell, so we need to correctly
 > handle line continuation to prevent complaining about the 'else' in:

 > ifdef FOOBAR
 > 	if true; \
 > 	    ... \
 > 	else \
 > 	    ... \
 > 	fi
 > endif

 > We don't add the 'else' and 'elif' statements to start_conditional, because
 > it would cause incorrect nesting counting in class OverriddenVariable.

 > Signed-off-by: Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>

Committed to 2020.02.x and 2020.11.x, thanks.
diff mbox series

Patch

diff --git a/utils/checkpackagelib/lib_mk.py b/utils/checkpackagelib/lib_mk.py
index 45e37e4598..0278354434 100644
--- a/utils/checkpackagelib/lib_mk.py
+++ b/utils/checkpackagelib/lib_mk.py
@@ -16,12 +16,13 @@  from checkpackagelib.lib import Utf8Characters         # noqa: F401
 
 # used in more than one check
 start_conditional = ["ifdef", "ifeq", "ifndef", "ifneq"]
+continue_conditional = ["elif", "else"]
 end_conditional = ["endif"]
 
 
 class Indent(_CheckFunction):
     COMMENT = re.compile(r"^\s*#")
-    CONDITIONAL = re.compile(r"^\s*({})\s".format("|".join(start_conditional + end_conditional)))
+    CONDITIONAL = re.compile(r"^\s*({})\s".format("|".join(start_conditional + end_conditional + continue_conditional)))
     ENDS_WITH_BACKSLASH = re.compile(r"^[^#].*\\$")
     END_DEFINE = re.compile(r"^\s*endef\s")
     MAKEFILE_TARGET = re.compile(r"^[^# \t]+:\s")
@@ -43,7 +44,7 @@  class Indent(_CheckFunction):
         expect_tabs = False
         if self.define or self.backslash or self.makefile_target:
             expect_tabs = True
-        if self.CONDITIONAL.search(text):
+        if not self.backslash and self.CONDITIONAL.search(text):
             expect_tabs = False
 
         # calculate for next line