diff mbox series

[1/1] utils/check-package: Add a quiet flag

Message ID 20190702185227.14435-1-brandon.maier@rockwellcollins.com
State Accepted
Headers show
Series [1/1] utils/check-package: Add a quiet flag | expand

Commit Message

Brandon Maier July 2, 2019, 6:52 p.m. UTC
When running in a CI system, stat messages become white noise. Introduce
an option to suppress non-error, non-warning, messages.

Signed-off-by: Brandon Maier <brandon.maier@rockwellcollins.com>
---
 utils/check-package | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

Comments

Arnout Vandecappelle July 3, 2019, 9:39 p.m. UTC | #1
Hi Brandon,

On 02/07/2019 20:52, Brandon Maier wrote:
> When running in a CI system, stat messages become white noise. Introduce
> an option to suppress non-error, non-warning, messages.
> 
> Signed-off-by: Brandon Maier <brandon.maier@rockwellcollins.com>

 Applied to master, thanks.

 However, could you give an example of a case where this is annoying in CI
output? If I look at e.g. the output in gitlab-ci [1], the cruft that is added
by gitlab-ci itself makes it pretty verbose already.

 Regards,
 Arnout

[1] https://gitlab.com/buildroot.org/buildroot/-/jobs/242921394


> ---
>  utils/check-package | 7 +++++--
>  1 file changed, 5 insertions(+), 2 deletions(-)
> 
> diff --git a/utils/check-package b/utils/check-package
> index ce1fe98d67..f09aaeea03 100755
> --- a/utils/check-package
> +++ b/utils/check-package
> @@ -33,6 +33,7 @@ def parse_args():
>                          default="http://nightly.buildroot.org/",
>                          help="default: %(default)s")
>      parser.add_argument("--verbose", "-v", action="count", default=0)
> +    parser.add_argument("--quiet", "-q", action="count", default=0)
>  
>      # Now the debug options in the order they are processed.
>      parser.add_argument("--include-only", dest="include_list", action="append",
> @@ -177,8 +178,10 @@ def __main__():
>      # (e.g. counted by 'wc'), so for stats use stderr. Wait all warnings are
>      # printed, for the case there are many of them, before printing stats.
>      sys.stdout.flush()
> -    print("{} lines processed".format(total_lines), file=sys.stderr)
> -    print("{} warnings generated".format(total_warnings), file=sys.stderr)
> +
> +    if not flags.quiet:
> +        print("{} lines processed".format(total_lines), file=sys.stderr)
> +        print("{} warnings generated".format(total_warnings), file=sys.stderr)
>  
>      if total_warnings > 0:
>          sys.exit(1)
>
Peter Korsgaard July 7, 2019, 6:42 a.m. UTC | #2
>>>>> "Brandon" == Brandon Maier <brandon.maier@rockwellcollins.com> writes:

 > When running in a CI system, stat messages become white noise. Introduce
 > an option to suppress non-error, non-warning, messages.

 > Signed-off-by: Brandon Maier <brandon.maier@rockwellcollins.com>

While not really a fix, it seems quite safe and it is easier when
tooling behaves the same on the various branches, so committed to
2019.02.x and 2019.05.x - Thanks.
Brandon Maier July 7, 2019, 2:43 p.m. UTC | #3
On Wed, Jul 3, 2019, 4:39 PM Arnout Vandecappelle <arnout@mind.be> wrote:

>  Hi Brandon,
>
> On 02/07/2019 20:52, Brandon Maier wrote:
> > When running in a CI system, stat messages become white noise. Introduce
> > an option to suppress non-error, non-warning, messages.
> >
> > Signed-off-by: Brandon Maier <brandon.maier@rockwellcollins.com>
>
>  Applied to master, thanks.

Thanks

>
>  However, could you give an example of a case where this is annoying in CI
> output? If I look at e.g. the output in gitlab-ci [1], the cruft that is
> added
> by gitlab-ci itself makes it pretty verbose already.
>

We have a custom tool to run various checks on our team's pull requests and
display findings. E.g. check-package, checkpatch, shellcheck, pylint, etc.

It's a simple tool though, and dumps stdout/stderr into the report. So it
assumes no output means everything is okay. All the other checkers have a
-q equivalent, so figured it'd be easiest to add it to check-package as
well.


>  Regards,
>  Arnout
>
> [1] https://gitlab.com/buildroot.org/buildroot/-/jobs/242921394
>
>
> > ---
> >  utils/check-package | 7 +++++--
> >  1 file changed, 5 insertions(+), 2 deletions(-)
> >
> > diff --git a/utils/check-package b/utils/check-package
> > index ce1fe98d67..f09aaeea03 100755
> > --- a/utils/check-package
> > +++ b/utils/check-package
> > @@ -33,6 +33,7 @@ def parse_args():
> >                          default="http://nightly.buildroot.org/",
> >                          help="default: %(default)s")
> >      parser.add_argument("--verbose", "-v", action="count", default=0)
> > +    parser.add_argument("--quiet", "-q", action="count", default=0)
> >
> >      # Now the debug options in the order they are processed.
> >      parser.add_argument("--include-only", dest="include_list",
> action="append",
> > @@ -177,8 +178,10 @@ def __main__():
> >      # (e.g. counted by 'wc'), so for stats use stderr. Wait all
> warnings are
> >      # printed, for the case there are many of them, before printing
> stats.
> >      sys.stdout.flush()
> > -    print("{} lines processed".format(total_lines), file=sys.stderr)
> > -    print("{} warnings generated".format(total_warnings),
> file=sys.stderr)
> > +
> > +    if not flags.quiet:
> > +        print("{} lines processed".format(total_lines), file=sys.stderr)
> > +        print("{} warnings generated".format(total_warnings),
> file=sys.stderr)
> >
> >      if total_warnings > 0:
> >          sys.exit(1)
> >
>
diff mbox series

Patch

diff --git a/utils/check-package b/utils/check-package
index ce1fe98d67..f09aaeea03 100755
--- a/utils/check-package
+++ b/utils/check-package
@@ -33,6 +33,7 @@  def parse_args():
                         default="http://nightly.buildroot.org/",
                         help="default: %(default)s")
     parser.add_argument("--verbose", "-v", action="count", default=0)
+    parser.add_argument("--quiet", "-q", action="count", default=0)
 
     # Now the debug options in the order they are processed.
     parser.add_argument("--include-only", dest="include_list", action="append",
@@ -177,8 +178,10 @@  def __main__():
     # (e.g. counted by 'wc'), so for stats use stderr. Wait all warnings are
     # printed, for the case there are many of them, before printing stats.
     sys.stdout.flush()
-    print("{} lines processed".format(total_lines), file=sys.stderr)
-    print("{} warnings generated".format(total_warnings), file=sys.stderr)
+
+    if not flags.quiet:
+        print("{} lines processed".format(total_lines), file=sys.stderr)
+        print("{} warnings generated".format(total_warnings), file=sys.stderr)
 
     if total_warnings > 0:
         sys.exit(1)