Skip to content
Snippets Groups Projects
Commit c58be6a0 authored by Timo Koch's avatar Timo Koch
Browse files

[doc][cmake] Improve dumux_evaluate_cmake_guard doc

parent 64af647a
No related branches found
No related tags found
1 merge request!2375Feature/cmake test drop dune26
...@@ -190,16 +190,14 @@ ...@@ -190,16 +190,14 @@
# :multi: # :multi:
# :argname: condition # :argname: condition
# #
# A number of conditions that CMake should evaluate before adding this # A number of conditions that CMake should evaluate.
# test. If one of the conditions fails, the test should be shown # Uses the same mechanics that `dumux_add_test` uses to evaluate its CMAKE_GUARD argument.
# as skipped in the test summary. Use this feature instead of guarding
# the call to :code:`dumux_add_test` with an :code:`if` clause.
# #
# The passed condition can be a complex expression like # The passed condition can be a complex expression like
# `( A OR B ) AND ( C OR D )`. Mind the spaces around the parentheses. # `( A OR B ) AND ( C OR D )`. Mind the spaces around the parentheses.
# #
# Example: Write CMAKE_GUARD dune-foo_FOUND if you want your test to only # Example: Write CMAKE_GUARD dune-foo_FOUND if you want to set a variable
# build and run when the dune-foo module is present. # that is only true if the module dune-foo has been found.
# #
# Note: This forwards to dune_add_test but enables another layer in case we need to support # Note: This forwards to dune_add_test but enables another layer in case we need to support
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment