help_options(**kwargs)
This functions create a target, to display an help message for the available options.
It will show the name, the type, the current and the default value, the description and maybe other information (in case of enumeration or advanced options) for each options.
Keyword Arguments
| Name | Type | Description |
|---|
PRINT_ON_CONF | bool | If set, it will print the generated help message in the terminal when doing the cmake configuration/generating the makefiles |
help_ips(**kwargs)
This functions create a target, to display an help message for the available IPs.
It will show the name and a description for each IPs.
Keyword Arguments
| Name | Type | Description |
|---|
PRINT_ON_CONF | bool | If set, it will print the generated help message in the terminal when doing the cmake configuration/generating the makefiles |
help_targets(**kwargs)
This functions create a target, to display an help message for the available targets.
It will show the name and a description for each targets.
Keyword Arguments
| Name | Type | Description |
|---|
PRINT_ON_CONF | bool | If set, it will print the generated help message in the terminal when doing the cmake configuration/generating the makefiles |
help_custom_targets(GROUP_NAME **kwargs)
This functions create a target, to display an help message for targets from a specific group, the pattern or a list needs to be given.
Parameters
| Name | Type | Description |
|---|
GROUP_NAME | string | Name of the group for the help message |
Keyword Arguments
| Name | Type | Description |
|---|
PRINT_ON_CONF | bool | If set, it will print the generated help message in the terminal when doing the cmake configuration/generating the makefiles |
DESCRIPTION | string | if set, it allows to add a custom description, by default it's set to be "Help for ${GROUP_NAME} targets". |
DONT_MAKE_GROUP | bool | if set, a new custom group won't be created |
PATTERN | string | pattern to be used to filter the custom target group. |
LIST | list[string] | List to be used to filter the custom target group. |
HELP_TARGET_NAME | string | if set, it will change the name of the help target created, by default, the help target is help_${GROUP_NAME} |
help_custom_ips(GROUP_NAME **kwargs)
This functions create a target, to display an help message for IPs from a specific group, the pattern or a list needs to be given.
Parameters
| Name | Type | Description |
|---|
GROUP_NAME | string | Name of the group for the help message |
Keyword Arguments
| Name | Type | Description |
|---|
PRINT_ON_CONF | bool | If set, it will print the generated help message in the terminal when doing the cmake configuration/generating the makefiles |
DESCRIPTION | string | if set, it allows to add a custom description, by default it's set to be "Help for ${GROUP_NAME} targets". |
PATTERN | string | pattern to be used to filter the custom target group. |
LIST | list[string] | List to be used to filter the custom target group. |
help_custom_options(GROUP_NAME **kwargs)
This functions create a target, to display an help message for options from a specific group, the pattern or a list needs to be given.
Parameters
| Name | Type | Description |
|---|
GROUP_NAME | string | Name of the group for the help message |
Keyword Arguments
| Name | Type | Description |
|---|
PRINT_ON_CONF | bool | If set, it will print the generated help message in the terminal when doing the cmake configuration/generating the makefiles |
DESCRIPTION | string | if set, it allows to add a custom description, by default it's set to be "Help for ${GROUP_NAME} targets". |
PATTERN | string | pattern to be used to filter the custom target group. |
LIST | list[string] | List to be used to filter the custom target group. |
help(**kwargs)
This function act as a wrapper, it create an help_all target that will display an help message for targets, IPs and options.
Keyword Arguments
| Name | Type | Description |
|---|
PRINT_ON_CONF | bool | If set, it will print the generated help message in the terminal when doing the cmake configuration/generating the makefiles |