Skip to content

Commit

Permalink
Rename function for cet_test_env_* consistency
Browse files Browse the repository at this point in the history
  • Loading branch information
knoepfel committed Nov 10, 2023
1 parent 02d3fe0 commit 2c9abf7
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
8 changes: 4 additions & 4 deletions Modules/CetTest.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -735,7 +735,7 @@ endfunction()
Clear the test environment in the current directory scope prior to
setting ``<var>=<val>``, including any environment modifications.
.. seealso:: :command:`cet_test_prepend_env`,
.. seealso:: :command:`cet_test_env_prepend`,
:variable:`CET_TEST_ENV_MODIFICATION`.
Details
Expand Down Expand Up @@ -803,21 +803,21 @@ function(cet_test_env_mod VAR OP)
endfunction()

#[================================================================[.rst:
.. command:: cet_test_prepend_env
.. command:: cet_test_env_prepend
Prepend to path-like environment variables in the test environment
for tests defined in and below the current directory.
.. code-block:: cmake
cet_test_prepend_env(<var> ...)
cet_test_env_prepend(<var> ...)
Functionally identical to :command:`cet_test_env_mod(<var>
path_list_prepend ...) <cet_test_env_mod>`
#]================================================================]

function(cet_test_prepend_env CET_ENV_VAR)
function(cet_test_env_prepend CET_ENV_VAR)
cet_test_env_mod(${CET_ENV_VAR} path_list_prepend ${ARGN})
set(CET_TEST_ENV_MODIFICATION "${CET_TEST_ENV_MODIFICATION}" PARENT_SCOPE)
endfunction()
Expand Down
2 changes: 1 addition & 1 deletion doc/reference/manual/cetmodules-commands.7.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Utility
* :command:`cet_test_assertion`
* :command:`cet_test_env`
* :command:`cet_test_env_mod`
* :command:`cet_test_prepend_env`
* :command:`cet_test_env_prepend`
* :command:`cet_timestamp`
* :command:`cet_version_cmp`
* :command:`parse_version_string`
Expand Down
2 changes: 1 addition & 1 deletion doc/reference/variable/CET_TEST_ENV.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ A directory-scope variable containing an initial value of the
property for tests defined by :command:`cet_test`. Modify with
:command:`cet_test_env`.

.. seealso:: :command:`cet_test_prepend_env`,
.. seealso:: :command:`cet_test_env_prepend`,
:variable:`CET_TEST_ENV_MODIFICATION`.
2 changes: 1 addition & 1 deletion doc/reference/variable/CET_TEST_ENV_MODIFICATION.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ A directory-scope variable containing an initial value of the
:prop_test:`ENVIRONMENT_MODIFICATION
<cmake-ref-current:prop_test:ENVIRONMENT_MODIFICATION>` property for
tests defined by :command:`cet_test`. Modify with
:command:`cet_test_prepend_env`.
:command:`cet_test_env_prepend`.

.. seealso:: :command:`cet_test_env`, :variable:`CET_TEST_ENV`.

0 comments on commit 2c9abf7

Please sign in to comment.