From: Daniel Borkmann <daniel@iogearbox.net>
To: Hu Haowen <2023002089@link.tyut.edu.cn>,
song@kernel.org, yonghong.song@linux.dev,
john.fastabend@gmail.com, kpsingh@kernel.org, sdf@google.com,
haoluo@google.com, jolsa@kernel.org, martin.lau@linux.dev
Cc: ast@kernel.org, andrii@kernel.org, bpf@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH] scripts/bpf_doc: add __main__ judgement before main code
Date: Fri, 1 Dec 2023 16:46:22 +0100 [thread overview]
Message-ID: <e7286e2d-76ea-8b50-54bd-751b649f9a4e@iogearbox.net> (raw)
In-Reply-To: <20231130145746.23621-1-2023002089@link.tyut.edu.cn>
Hi Hu,
On 11/30/23 3:57 PM, Hu Haowen wrote:
> When doing Python programming it is a nice convention to insert the if
> statement `if __name__ == "__main__":` before any main code that does
> actual functionalities to ensure the code will be executed only as a
> script rather than as an imported module. Hence attach the missing
> judgement to bpf_doc.py.
>
> Signed-off-by: Hu Haowen <2023002089@link.tyut.edu.cn>
Thanks for the patch. What's the concrete value of this one? Do you plan
to distribute the bpf_docs.py outside of the kernel tree? If it's not
needed feels somewhat too much churn/marginal value.
> scripts/bpf_doc.py | 81 +++++++++++++++++++++++-----------------------
> 1 file changed, 41 insertions(+), 40 deletions(-)
>
> diff --git a/scripts/bpf_doc.py b/scripts/bpf_doc.py
> index 61b7dddedc46..af2a87d97832 100755
> --- a/scripts/bpf_doc.py
> +++ b/scripts/bpf_doc.py
> @@ -851,43 +851,44 @@ class PrinterHelpers(Printer):
>
> ###############################################################################
>
> -# If script is launched from scripts/ from kernel tree and can access
> -# ../include/uapi/linux/bpf.h, use it as a default name for the file to parse,
> -# otherwise the --filename argument will be required from the command line.
> -script = os.path.abspath(sys.argv[0])
> -linuxRoot = os.path.dirname(os.path.dirname(script))
> -bpfh = os.path.join(linuxRoot, 'include/uapi/linux/bpf.h')
> -
> -printers = {
> - 'helpers': PrinterHelpersRST,
> - 'syscall': PrinterSyscallRST,
> -}
> -
> -argParser = argparse.ArgumentParser(description="""
> -Parse eBPF header file and generate documentation for the eBPF API.
> -The RST-formatted output produced can be turned into a manual page with the
> -rst2man utility.
> -""")
> -argParser.add_argument('--header', action='store_true',
> - help='generate C header file')
> -if (os.path.isfile(bpfh)):
> - argParser.add_argument('--filename', help='path to include/uapi/linux/bpf.h',
> - default=bpfh)
> -else:
> - argParser.add_argument('--filename', help='path to include/uapi/linux/bpf.h')
> -argParser.add_argument('target', nargs='?', default='helpers',
> - choices=printers.keys(), help='eBPF API target')
> -args = argParser.parse_args()
> -
> -# Parse file.
> -headerParser = HeaderParser(args.filename)
> -headerParser.run()
> -
> -# Print formatted output to standard output.
> -if args.header:
> - if args.target != 'helpers':
> - raise NotImplementedError('Only helpers header generation is supported')
> - printer = PrinterHelpers(headerParser)
> -else:
> - printer = printers[args.target](headerParser)
> -printer.print_all()
> +if __name__ == "__main__":
> + # If script is launched from scripts/ from kernel tree and can access
> + # ../include/uapi/linux/bpf.h, use it as a default name for the file to parse,
> + # otherwise the --filename argument will be required from the command line.
> + script = os.path.abspath(sys.argv[0])
> + linuxRoot = os.path.dirname(os.path.dirname(script))
> + bpfh = os.path.join(linuxRoot, 'include/uapi/linux/bpf.h')
> +
> + printers = {
> + 'helpers': PrinterHelpersRST,
> + 'syscall': PrinterSyscallRST,
> + }
> +
> + argParser = argparse.ArgumentParser(description="""
> + Parse eBPF header file and generate documentation for the eBPF API.
> + The RST-formatted output produced can be turned into a manual page with the
> + rst2man utility.
> + """)
> + argParser.add_argument('--header', action='store_true',
> + help='generate C header file')
> + if (os.path.isfile(bpfh)):
> + argParser.add_argument('--filename', help='path to include/uapi/linux/bpf.h',
> + default=bpfh)
> + else:
> + argParser.add_argument('--filename', help='path to include/uapi/linux/bpf.h')
> + argParser.add_argument('target', nargs='?', default='helpers',
> + choices=printers.keys(), help='eBPF API target')
> + args = argParser.parse_args()
> +
> + # Parse file.
> + headerParser = HeaderParser(args.filename)
> + headerParser.run()
> +
> + # Print formatted output to standard output.
> + if args.header:
> + if args.target != 'helpers':
> + raise NotImplementedError('Only helpers header generation is supported')
> + printer = PrinterHelpers(headerParser)
> + else:
> + printer = printers[args.target](headerParser)
> + printer.print_all()
>
next prev parent reply other threads:[~2023-12-01 15:46 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-11-30 14:57 [PATCH] scripts/bpf_doc: add __main__ judgement before main code Hu Haowen
2023-12-01 15:46 ` Daniel Borkmann [this message]
2023-12-02 5:56 ` Hu Haowen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=e7286e2d-76ea-8b50-54bd-751b649f9a4e@iogearbox.net \
--to=daniel@iogearbox.net \
--cc=2023002089@link.tyut.edu.cn \
--cc=andrii@kernel.org \
--cc=ast@kernel.org \
--cc=bpf@vger.kernel.org \
--cc=haoluo@google.com \
--cc=john.fastabend@gmail.com \
--cc=jolsa@kernel.org \
--cc=kpsingh@kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=martin.lau@linux.dev \
--cc=sdf@google.com \
--cc=song@kernel.org \
--cc=yonghong.song@linux.dev \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox