Re: [Buildroot] [PATCH/master 2/7] g-ir-scanner-qemuwrapper.in: Fix shellcheck warnings, switch to sh

From: "Yann E. MORIN" <yann.morin.1998@free.fr>
To: Arnout Vandecappelle <arnout@mind.be>
Cc: Romain Naour <romain.naour@gmail.com>,
	Anisse Astier <anisse@astier.eu>,
	Adam Duskett <aduskett@gmail.com>,
	buildroot@buildroot.org
Subject: Re: [Buildroot] [PATCH/master 2/7] g-ir-scanner-qemuwrapper.in: Fix shellcheck warnings, switch to sh
Date: Sat, 11 Sep 2021 21:49:57 +0200	[thread overview]
Message-ID: <20210911194957.GV1053080@scaer> (raw)
In-Reply-To: <016fa6ef-0efa-030b-3e27-c2e7ff6db844@mind.be>

Arnout, All,

On 2021-09-11 20:57 +0200, Arnout Vandecappelle spake thusly:
> On 03/09/2021 18:20, Adam Duskett wrote:
> >   - Add double quotes to prevent globbing and word splitting.
> >   - Add indentations of continuation lines.
> >   - Disable SC2181 and SC2016 as we explicitly do not want the variables
> >     expanded in the echo.
> > 
> > Signed-off-by: Adam Duskett <aduskett@gmail.com>
> > ---
> >  .../g-ir-scanner-qemuwrapper.in                  | 16 +++++++++-------
> >  1 file changed, 9 insertions(+), 7 deletions(-)
> > 
> > diff --git a/package/gobject-introspection/g-ir-scanner-qemuwrapper.in b/package/gobject-introspection/g-ir-scanner-qemuwrapper.in
> > index ec066062e2..5ece75d0a4 100644
> > --- a/package/gobject-introspection/g-ir-scanner-qemuwrapper.in
> > +++ b/package/gobject-introspection/g-ir-scanner-qemuwrapper.in
> > @@ -1,18 +1,20 @@
> > -#!/usr/bin/env bash
> > +#!/usr/bin/env sh
> >  
> > -# Pass -r to qemu-user as to trick glibc into not errorings out if the host kernel
> > +# Pass -r to qemu-user as to trick glibc into not erroring out if the host kernel
> >  # is older than the target kernel.
> >  # Use a modules directory which does not exist so we don't load random things
> >  # which may then get deleted (or their dependencies) and potentially segfault
> >  GOI_LIBRARY_PATH="${GIR_EXTRA_LIBS_PATH:+${GIR_EXTRA_LIBS_PATH}:}.libs:$(dirname "$0")/../lib:$(dirname "$0")/../../lib"
> > -GIO_MODULE_DIR=$(dirname $0)/../lib/gio/modules-dummy \
> > +GIO_MODULE_DIR="$(dirname "$0")/../lib/gio/modules-dummy" \
> >  @QEMU_USER@ -r @TOOLCHAIN_HEADERS_VERSION@ \
> > --L $(dirname $0)/../../ \
> > --E LD_LIBRARY_PATH="${GOI_LIBRARY_PATH}" \
> > -"$@"
> > +    -L "$(dirname "$0")/../../" \
> > +    -E LD_LIBRARY_PATH="${GOI_LIBRARY_PATH}" \
> > +    "$@"
> >  
> > -if [[ $? -ne 0 ]]; then
> > +# shellcheck disable=SC2181
> 
>  Instead of adding an exception, we could just do the right thing:
> 
> if ! @QEMU_USER@ -r ... \
>     ... \
> then
>     ...
> 
>  But since I wasn't going to test this change, I left it as is.

I also considered it when Adam and I discussed this patch on IRC, but I
side with him to keep the code as-is, but forgot to explain why so that
he could add that to the commit log.

So for the posterity, here is my reasonning:

    Continuation lines in a condition are ugly and make an if-then-else
    condition harder to grok, so we prefer adding an SC2181 exception as
    it leaves the code more readable.

Regards,
Yann E. MORIN.

-- 
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 561 099 427 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'
_______________________________________________
buildroot mailing list
buildroot@lists.buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot