[PATCH bpf] bpf_doc: use silent mode when exec make cmd

[PATCH bpf] bpf_doc: use silent mode when exec make cmd

[Hangbin Liu]

When getting kernel version via make, the result may be polluted by other
output, like directory change info. e.g.
$ export MAKEFLAGS="-w"
$ make kernelversion
make: Entering directory '/home/net'
6.8.0
make: Leaving directory '/home/net'

This will distort the reStructuredText output and make latter rst2man
failed like:
bpf-helpers.rst:20: (WARNING/2) Field list ends without a blank line; unexpected unindent.

Using silent mode would help. e.g.
$ make -s --no-print-directory kernelversion
6.8.0

Fixes: fd0a38f9c37d ("scripts/bpf: Set version attribute for bpf-helpers(7) man page")
Signed-off-by: Michael Hofmann <mhofmann@redhat.com>
Signed-off-by: Hangbin Liu <liuhangbin@gmail.com>
---
 scripts/bpf_doc.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/scripts/bpf_doc.py b/scripts/bpf_doc.py
index 4606944984ee..c55878bddfdd 100755
--- a/scripts/bpf_doc.py
+++ b/scripts/bpf_doc.py
@@ -414,8 +414,8 @@ class PrinterRST(Printer):
             version = version.stdout.decode().rstrip()
         except:
             try:
-                version = subprocess.run(['make', 'kernelversion'], cwd=linuxRoot,
-                                         capture_output=True, check=True)
+                version = subprocess.run(['make', '-s', '--no-print-directory', 'kernelversion'],
+                                         cwd=linuxRoot, capture_output=True, check=True)
                 version = version.stdout.decode().rstrip()
             except:
                 return 'Linux'
-- 
2.43.0

Re: [PATCH bpf] bpf_doc: use silent mode when exec make cmd

[Quentin Monnet]

2024-03-15 02:34 UTC+0000 ~ Hangbin Liu <liuhangbin@gmail.com>
> When getting kernel version via make, the result may be polluted by other
> output, like directory change info. e.g.
> $ export MAKEFLAGS="-w"
> $ make kernelversion
> make: Entering directory '/home/net'
> 6.8.0
> make: Leaving directory '/home/net'
> 
> This will distort the reStructuredText output and make latter rst2man
> failed like:
> bpf-helpers.rst:20: (WARNING/2) Field list ends without a blank line; unexpected unindent.
> 
> Using silent mode would help. e.g.
> $ make -s --no-print-directory kernelversion
> 6.8.0
> 
> Fixes: fd0a38f9c37d ("scripts/bpf: Set version attribute for bpf-helpers(7) man page")
> Signed-off-by: Michael Hofmann <mhofmann@redhat.com>
> Signed-off-by: Hangbin Liu <liuhangbin@gmail.com>
> ---
>  scripts/bpf_doc.py | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/scripts/bpf_doc.py b/scripts/bpf_doc.py
> index 4606944984ee..c55878bddfdd 100755
> --- a/scripts/bpf_doc.py
> +++ b/scripts/bpf_doc.py
> @@ -414,8 +414,8 @@ class PrinterRST(Printer):
>              version = version.stdout.decode().rstrip()
>          except:
>              try:
> -                version = subprocess.run(['make', 'kernelversion'], cwd=linuxRoot,
> -                                         capture_output=True, check=True)
> +                version = subprocess.run(['make', '-s', '--no-print-directory', 'kernelversion'],
> +                                         cwd=linuxRoot, capture_output=True, check=True)
>                  version = version.stdout.decode().rstrip()
>              except:
>                  return 'Linux'

Reviewed-by: Quentin Monnet <qmo@kernel.org>

This can probably go through bpf-next, though.

Thanks!

Re: [PATCH bpf] bpf_doc: use silent mode when exec make cmd

[Alejandro Colomar]

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

Hi!

On Fri, Mar 15, 2024 at 10:34:43AM +0800, Hangbin Liu wrote:
> When getting kernel version via make, the result may be polluted by other
> output, like directory change info. e.g.
> $ export MAKEFLAGS="-w"
> $ make kernelversion
> make: Entering directory '/home/net'
> 6.8.0
> make: Leaving directory '/home/net'
> 
> This will distort the reStructuredText output and make latter rst2man
> failed like:
> bpf-helpers.rst:20: (WARNING/2) Field list ends without a blank line; unexpected unindent.
> 
> Using silent mode would help. e.g.
> $ make -s --no-print-directory kernelversion

Acked-by: Alejandro Colomar <alx@kernel.org>

Thanks!
Alex

> 6.8.0
> 
> Fixes: fd0a38f9c37d ("scripts/bpf: Set version attribute for bpf-helpers(7) man page")
> Signed-off-by: Michael Hofmann <mhofmann@redhat.com>
> Signed-off-by: Hangbin Liu <liuhangbin@gmail.com>
> ---
>  scripts/bpf_doc.py | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/scripts/bpf_doc.py b/scripts/bpf_doc.py
> index 4606944984ee..c55878bddfdd 100755
> --- a/scripts/bpf_doc.py
> +++ b/scripts/bpf_doc.py
> @@ -414,8 +414,8 @@ class PrinterRST(Printer):
>              version = version.stdout.decode().rstrip()
>          except:
>              try:
> -                version = subprocess.run(['make', 'kernelversion'], cwd=linuxRoot,
> -                                         capture_output=True, check=True)
> +                version = subprocess.run(['make', '-s', '--no-print-directory', 'kernelversion'],
> +                                         cwd=linuxRoot, capture_output=True, check=True)
>                  version = version.stdout.decode().rstrip()
>              except:
>                  return 'Linux'
> -- 
> 2.43.0
> 

-- 
<https://www.alejandro-colomar.es/>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH bpf] bpf_doc: use silent mode when exec make cmd

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to bpf/bpf.git (master)
by Daniel Borkmann <daniel@iogearbox.net>:

On Fri, 15 Mar 2024 10:34:43 +0800 you wrote:
> When getting kernel version via make, the result may be polluted by other
> output, like directory change info. e.g.
> $ export MAKEFLAGS="-w"
> $ make kernelversion
> make: Entering directory '/home/net'
> 6.8.0
> make: Leaving directory '/home/net'
> 
> [...]

Here is the summary with links:
  - [bpf] bpf_doc: use silent mode when exec make cmd
    https://git.kernel.org/bpf/bpf/c/5384cc0d1a88

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html