fgen.cmake_help#
Help with CMakeLists.txt files
get_cmake_lists_help_string#
- get_cmake_lists_help_string(written_paths, cmake_prefix)[source]#
Get help string for files to include in a CMakeLists.txt file
- Parameters:
written_paths (
list[pathlib.Path]) – Input paths to include in the help messagecmake_prefix (
str) –Prefix to apply to the paths in the help string.
This can make it easier if you want to copy and paste these messages later.
- Returns:
str– Help string that includes the sorted paths with the prefix and some instructions.
log_cmake_lists_help#
- log_cmake_lists_help(written_wrappers, cmake_prefix)[source]#
Log help for the lines that will probably be needed in a CMakeLists.txt file
- Parameters:
written_wrappers (
collections.abc.Iterable[fgen.wrapper_building.WrittenWrappers]) – The wrappers that were written by {py:mod}`fgen`cmake_prefix (
str) –Prefix to apply to the paths in the help string.
This can make it easier if you want to copy and paste these messages later.
- Return type: