search

xen-troops / moulin

Moulin is meta build system that is capable of building multiple images at once
Apache License 2.0
2 stars 15 forks source link

Improve the usage info #116

Closed rshym closed 3 months ago

rshym commented 3 months ago

Original output of the script

$ moulin --help-config prod-devel-rcar.yaml 
usage: /home/rsm/.local/bin/moulin prod-devel-rcar.yaml
                                                        [--MACHINE {salvator-xs-m3-2x4g,salvator-xs-h3-4x2g,salvator-x-h3-4x2g,h3ulcb-4x2g,h3ulcb-4x2g-kf,h3ulcb-4x2g-ab}]
                                                        [--ENABLE_ANDROID {no,yes}] [--ENABLE_DOMU {no,yes}] [--ENABLE_ZEPHYR {no,yes}] [--ENABLE_MM {no,yes}]
                                                        [--ENABLE_AOS_VIS {no,yes}] [--GRAPHICS {binaries,sources}]

Config file description: Xen-Troops development setup for Renesas RCAR Gen3 hardware

optional arguments:
  --MACHINE {salvator-xs-m3-2x4g,salvator-xs-h3-4x2g,salvator-x-h3-4x2g,h3ulcb-4x2g,h3ulcb-4x2g-kf,h3ulcb-4x2g-ab}
                        RCAR Gen3-based device
  --ENABLE_ANDROID {no,yes}
                        Build Android as a guest VM
  --ENABLE_DOMU {no,yes}
                        Build generic Yocto-based DomU
  --ENABLE_ZEPHYR {no,yes}
                        Build Zephyr as guest domain
  --ENABLE_MM {no,yes}  Enable Multimedia support
  --ENABLE_AOS_VIS {no,yes}
                        Enable AOS VIS service
  --GRAPHICS {binaries,sources}
                        Select how to use the GFX (3D hardware accelerator)

With this PR applied

$ /mnt/t1/projects/moulin/moulin.py --help-config prod-devel-rcar.yaml 
usage: moulin.py prod-devel-rcar.yaml [--MACHINE {salvator-xs-m3-2x4g,salvator-xs-h3-4x2g,salvator-x-h3-4x2g,h3ulcb-4x2g,h3ulcb-4x2g-kf,h3ulcb-4x2g-ab}]
                                      [--ENABLE_ANDROID {no,yes}] [--ENABLE_DOMU {no,yes}] [--ENABLE_ZEPHYR {no,yes}] [--ENABLE_MM {no,yes}]
                                      [--ENABLE_AOS_VIS {no,yes}] [--GRAPHICS {binaries,sources}]

Config file description: Xen-Troops development setup for Renesas RCAR Gen3 hardware

optional arguments:
  --MACHINE {salvator-xs-m3-2x4g,salvator-xs-h3-4x2g,salvator-x-h3-4x2g,h3ulcb-4x2g,h3ulcb-4x2g-kf,h3ulcb-4x2g-ab}
                        RCAR Gen3-based device (default: h3ulcb-4x2g)
  --ENABLE_ANDROID {no,yes}
                        Build Android as a guest VM (default: no)
  --ENABLE_DOMU {no,yes}
                        Build generic Yocto-based DomU (default: no)
  --ENABLE_ZEPHYR {no,yes}
                        Build Zephyr as guest domain (default: no)
  --ENABLE_MM {no,yes}  Enable Multimedia support (default: no)
  --ENABLE_AOS_VIS {no,yes}
                        Enable AOS VIS service (default: no)
  --GRAPHICS {binaries,sources}
                        Select how to use the GFX (3D hardware accelerator) (default: sources)
rshym commented 3 months ago

Rb is added. No functional testing is required, due to changes in the help message only. Ready to be merged.