Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Tooling] Command Line Usage for 'scripts/tools/zap/run_zaptool.sh' Is Not Easily Discoverable #35546

Closed
gerickson opened this issue Sep 11, 2024 · 1 comment

Comments

@gerickson
Copy link
Contributor

Reproduction steps / Feature

In the the Matter documentation at https://project-chip.github.io/connectedhomeip-doc/getting_started/zap.html, it discusses running the zap tool via scripts/tools/zap/run_zaptool.sh. The run_zaptool.sh usage is summarized in the documentation; however, it is not easily discoverable that, first and foremost, there is a usage option for run_zaptool.sh and that usage option is invoked with --help.

Make the usage of run_zaptool.sh discoverable and make it also support the command -h option in addition to --help to invoke a usage summary.

Platform

other

Platform Version(s)

No response

Type

Manually tested with SDK

(Optional) If manually tested please explain why this is only manually tested

No response

Anything else?

See above documentation at https://project-chip.github.io/connectedhomeip-doc/getting_started/zap.html.

gerickson added a commit to Nuovations/connectedhomeip that referenced this issue Sep 12, 2024
…roject-chip#35546).

* Formalize command line option and argument processing.

* Add support '-h' for usage in addition to '--help'.

* Change shebang from '/bin/bash' to '/usr/bin/env bash'.

* Update the file copyright header.
gerickson added a commit to Nuovations/connectedhomeip that referenced this issue Sep 12, 2024
…roject-chip#35546).

* Formalize command line option and argument processing.

* Add support '-h' for usage in addition to '--help'.

* Change shebang from '/bin/bash' to '/usr/bin/env bash'.

* Update the file copyright header.
gerickson added a commit to Nuovations/connectedhomeip that referenced this issue Sep 12, 2024
…roject-chip#35546).

* Formalize command line option and argument processing.

* Add support '-h' for usage in addition to '--help'.

* Change shebang from '/bin/bash' to '/usr/bin/env bash'.

* Update the file copyright header.
andy31415 pushed a commit that referenced this issue Sep 13, 2024
…35546). (#35548)

* Formalize command line option and argument processing.

* Add support '-h' for usage in addition to '--help'.

* Change shebang from '/bin/bash' to '/usr/bin/env bash'.

* Update the file copyright header.
@gerickson
Copy link
Contributor Author

Closed with #35548.

yyzhong-g pushed a commit to yyzhong-g/connectedhomeip that referenced this issue Dec 12, 2024
…roject-chip#35546). (project-chip#35548)

* Formalize command line option and argument processing.

* Add support '-h' for usage in addition to '--help'.

* Change shebang from '/bin/bash' to '/usr/bin/env bash'.

* Update the file copyright header.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant