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

add help(), help_targets(), help_ips() functions for help messages #65

Merged
merged 1 commit into from
Sep 15, 2024

Conversation

Risto97
Copy link
Contributor

@Risto97 Risto97 commented Sep 15, 2024

This pull request adds functions:

  • help_targets() - Prints all targets and their description in the build
  • help_ips() - Prints all IPs and their descriptions.
  • help() - Prints both targets and IPs help messages

2024-09-15T10:52:59,213558953+02:00

To 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 have DESCRIPTION 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:

if(PROJECT_IS_TOP_LEVEL)
    help()
endif()

@Risto97
Copy link
Contributor Author

Risto97 commented Sep 15, 2024

resolve #63

@Risto97 Risto97 merged commit 0ac4dfe into develop Sep 15, 2024
1 check passed
@Risto97 Risto97 deleted the help branch September 15, 2024 09:00
@Risto97
Copy link
Contributor Author

Risto97 commented Sep 15, 2024

Resolve #61

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant