HEP-SoC / SoCMake

CMake based hardware build system
https://hep-soc.github.io/SoCMake/
GNU Lesser General Public License v3.0
8 stars 1 forks source link

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

Closed Risto97 closed 2 months ago

Risto97 commented 2 months ago

This pull request adds functions:

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 commented 2 months ago

resolve #63

Risto97 commented 2 months ago

Resolve #61