mirror/buildroot
1
0
Fork 0
mirror of https://gitlab.com/buildroot.org/buildroot.git synced 2026-10-28 11:42:24 -09:00
Code Issues Packages Projects Releases Wiki Activity

utils/generate-cyclonedx: improve help text

Browse Source 
The argparse has a set of arguments you can pass to the ArgumentParser
object to improve the looks of the help message.

The example usage used to be defined in the "description" but a "usage"
field exists [1].

Also link to the documentation in the epilog [2].

[1] https://docs.python.org/3/library/argparse.html#usage
[2] https://docs.python.org/3/library/argparse.html#epilog

Signed-off-by: Thomas Perale <thomas.perale@mind.be>
Signed-off-by: Arnout Vandecappelle <arnout@rnout.be>
(cherry picked from commit c13eabf18f)
Signed-off-by: Raphaël Mélotte <raphael.melotte@mind.be>
This commit is contained in:
Thomas Perale
2026-10-11 11:42:13 +02:00
committed by Raphaël Mélotte
parent 5d484774ab
commit ca734db972
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
utils/generate-cyclonedx
View File

@@ -529,9 +529,9 @@ def br2_root_deps(show_info_dict, virtual=False) -> list:
def main():
parser = argparse.ArgumentParser(
description='''Create a CycloneDX SBoM for the Buildroot configuration.
Example usage: make show-info | utils/generate-cyclonedx > sbom.json
''',
description="Create a CycloneDX SBoM for the Buildroot configuration.",
usage="make show-info | utils/%(prog)s > sbom.json",
epilog="For more information see https://buildroot.org/downloads/manual/manual.html#_generating_cyclonedx_sbom",
formatter_class=argparse.ArgumentDefaultsHelpFormatter
)
parser.add_argument("-i", "--in-file", nargs="?", type=argparse.FileType("r"),