diff mbox series

[02/16] utils/check-package: improve shellcheck reproducibility

Message ID 20220724054912.2354219-3-ricardo.martincoski@gmail.com
State Accepted
Headers show
Series Preventing style regressions using check-package | expand

Commit Message

Ricardo Martincoski July 24, 2022, 5:48 a.m. UTC
shellcheck is already in use to check SysV init scripts.
Currently its results can be affected by the existence of a
.shellcheckrc file in any parent directory.

For instance, in this example:
(1) /path/.shellcheckrc
(2) /path/to/.shellcheckrc
(3) /path/to/buildroot
the configs from file (1) are ignored and the configs from file (2)
override the default values from the shellcheck binary.
So the config file affects the check-package result for SysV scripts.

Avoid this reproducibility issue by adding an empty config file to the
buildroot topdir.

It can also eventually contain configs (different from default values
from sheelcheck) that we want as a standard to all shell scripts tested
by check-package.

Signed-off-by: Ricardo Martincoski <ricardo.martincoski@gmail.com>
---
 .shellcheckrc | 0
 DEVELOPERS    | 1 +
 2 files changed, 1 insertion(+)
 create mode 100644 .shellcheckrc

Comments

Arnout Vandecappelle July 25, 2022, 10:21 p.m. UTC | #1
On 24/07/2022 07:48, Ricardo Martincoski wrote:
> shellcheck is already in use to check SysV init scripts.
> Currently its results can be affected by the existence of a
> .shellcheckrc file in any parent directory.
> 
> For instance, in this example:
> (1) /path/.shellcheckrc
> (2) /path/to/.shellcheckrc
> (3) /path/to/buildroot
> the configs from file (1) are ignored and the configs from file (2)
> override the default values from the shellcheck binary.
> So the config file affects the check-package result for SysV scripts.
> 
> Avoid this reproducibility issue by adding an empty config file to the
> buildroot topdir.
> 
> It can also eventually contain configs (different from default values
> from sheelcheck) that we want as a standard to all shell scripts tested
> by check-package.
> 
> Signed-off-by: Ricardo Martincoski <ricardo.martincoski@gmail.com>

  Applied to master, thanks.

  Regards,
  Arnout

> ---
>   .shellcheckrc | 0
>   DEVELOPERS    | 1 +
>   2 files changed, 1 insertion(+)
>   create mode 100644 .shellcheckrc
> 
> diff --git a/.shellcheckrc b/.shellcheckrc
> new file mode 100644
> index 0000000000..e69de29bb2
> diff --git a/DEVELOPERS b/DEVELOPERS
> index 00315ffe6f..8b2fdb8f6c 100644
> --- a/DEVELOPERS
> +++ b/DEVELOPERS
> @@ -2467,6 +2467,7 @@ F:	package/libhttpparser/
>   
>   N:	Ricardo Martincoski <ricardo.martincoski@datacom.com.br>
>   F:	.flake8
> +F:	.shellcheckrc
>   F:	package/atop/
>   F:	package/thermald/
>   F:	support/testing/infra/
diff mbox series

Patch

diff --git a/.shellcheckrc b/.shellcheckrc
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/DEVELOPERS b/DEVELOPERS
index 00315ffe6f..8b2fdb8f6c 100644
--- a/DEVELOPERS
+++ b/DEVELOPERS
@@ -2467,6 +2467,7 @@  F:	package/libhttpparser/
 
 N:	Ricardo Martincoski <ricardo.martincoski@datacom.com.br>
 F:	.flake8
+F:	.shellcheckrc
 F:	package/atop/
 F:	package/thermald/
 F:	support/testing/infra/