add help(), help_targets(), help_ips() functions for help messages #65
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request adds functions:
help_targets()
- Prints all targets and their description in the buildhelp_ips()
- Prints all IPs and their descriptions.help()
- Prints both targets and IPs help messagesTo make this useful, all the tool functions should set
DESCRIPTION
property on the targets it creates for 2nd column to be useful. (mentioned #64 )add_ip()
should also haveDESCRIPTION
optional argument (mentioned #62 ) in order to have useful information.These functions can be added only once per build flow.
It is recommended to add it at the end of the CMakeLists.txt file.
In order to ensure it is the only
help()
call, all levels of hierarchy should have a "top level guard" around the call: