Re: [Buildroot] [PATCH 3/4] utils/check-package: support ignore-indent flag for configurations

[Ricardo Martincoski <ricardo.martincoski@gmail.com>]

[-- Attachment #1: Type: text/plain, Size: 1574 bytes --]

Hello,

Sorry the long delay.

On Sat, Apr 29, 2023 at 03:12 PM, James Knight wrote:

> from: James Knight <james.d.knight@live.com>
> date: Sat, Apr 29 02:12 PM -04:00 2023
> to: buildroot@buildroot.org
> cc: James Knight <james.d.knight@live.com>, Ricardo Martincoski <ricardo.martincoski@datacom.com.br>
> subject: [Buildroot] [PATCH 3/4] utils/check-package: support ignore-indent flag for configurations
>
> This commit provides the ability for configuration scripts to hint at
> ignoring linter checks for expected indentations. By adding the line to
> a configuration file:
>
>     # noqa: ignore-indent

There is already support for comments in the form
    # check-package Indent
to not run a CheckFunction named Indent for the next source code line

It seems to me that using 'check-package' in the special comment does
make sense because someone reading the source file, for instance a
Config.in file, can immediately know it is something related to the
check-package script, while a 'noqa' would need to be documented in the
manual.
Also, using 'check-package' in the comment would keep consistency with
code that already exists.
Finally, it seems to me more future-proof to keep the naming space of all
flags/options inside each CheckFunction, so I would suggest a comment in
the form:

    # check-package Indent_ignore-menu-indent-below

that sets the flag named 'ignore-menu-indent-below' for the
CheckFunction named 'Indent' in the library that parses the type of file
that has the special comment, in the case of Config.in, lib_config.py.

Regards,
Ricardo

[-- Attachment #2: Type: text/plain, Size: 150 bytes --]

_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot