Skip to content

Commit

Permalink
Improve cet_cmake_module_directories() documentation per @knoepfel
Browse files Browse the repository at this point in the history
…request
  • Loading branch information
greenc-FNAL committed Feb 6, 2024
1 parent e98784f commit 775e06a
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions Modules/CetCMakeUtils.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -638,16 +638,25 @@ endfunction()
Also add the corresponding directories in the project build tree to
:variable:`CMAKE_MODULE_PATH
<cmake-ref-current:variable:CMAKE_MODULE_PATH>` in the current
scope.
scope (e.g. for generated CMake modules).
.. seealso:: :ref:`NO_LOCAL
<cet_cmake_module_directories-NO_LOCAL>`
.. rst-class:: text-start
.. seealso:: :command:`configure_file()
<cmake-ref-current:command:configure_file>`,
:command:`cet_make_plugin_builder`,
:command:`cet_collect_plugin_builders`.
.. _cet_cmake_module_directories-NO_CONFIG:
``NO_CONFIG``
Do not add these directories to :variable:`CMAKE_MODULE_PATH
<cmake-ref-current:variable:CMAKE_MODULE_PATH>` in the CMake config
file for ``<project>``.
.. seealso:: :ref:`NO_LOCAL
<cet_cmake_module_directories-NO_LOCAL>`
.. _cet_cmake_module_directories-NO_LOCAL:
``NO_LOCAL``
Expand All @@ -656,6 +665,9 @@ endfunction()
scope. Implied if ``<project>`` is not equal to the value of
:variable:`CETMODULES_CURRENT_PROJECT_NAME`
.. seealso:: :ref:`NO_CONFIG
<cet_cmake_module_directories-NO_CONFIG>`
``PROJECT <project>``
Specify the project to which these module directories belong. If
not specifed, ``<project>`` defaults to
Expand Down

0 comments on commit 775e06a

Please sign in to comment.