浏览代码

CMakeDependentOption: Document that 4th parameter follows if-syntax

Hong Xu 6 年之前
父节点
当前提交
d192caefff
共有 2 个文件被更改,包括 5 次插入2 次删除
  1. 2 0
      Help/command/if.rst
  2. 3 2
      Modules/CMakeDependentOption.cmake

+ 2 - 0
Help/command/if.rst

@@ -29,6 +29,8 @@ If used, it must be a verbatim
 repeat of the argument of the opening
 repeat of the argument of the opening
 ``if`` command.
 ``if`` command.
 
 
+.. _`Condition Syntax`:
+
 Condition Syntax
 Condition Syntax
 ^^^^^^^^^^^^^^^^
 ^^^^^^^^^^^^^^^^
 
 

+ 3 - 2
Modules/CMakeDependentOption.cmake

@@ -12,7 +12,7 @@ conditions are true.  When the option is not presented a default value
 is used, but any value set by the user is preserved for when the
 is used, but any value set by the user is preserved for when the
 option is presented again.  Example invocation:
 option is presented again.  Example invocation:
 
 
-::
+.. code-block:: cmake
 
 
   CMAKE_DEPENDENT_OPTION(USE_FOO "Use Foo" ON
   CMAKE_DEPENDENT_OPTION(USE_FOO "Use Foo" ON
                          "USE_BAR;NOT USE_ZOT" OFF)
                          "USE_BAR;NOT USE_ZOT" OFF)
@@ -21,7 +21,8 @@ If USE_BAR is true and USE_ZOT is false, this provides an option
 called USE_FOO that defaults to ON.  Otherwise, it sets USE_FOO to
 called USE_FOO that defaults to ON.  Otherwise, it sets USE_FOO to
 OFF.  If the status of USE_BAR or USE_ZOT ever changes, any value for
 OFF.  If the status of USE_BAR or USE_ZOT ever changes, any value for
 the USE_FOO option is saved so that when the option is re-enabled it
 the USE_FOO option is saved so that when the option is re-enabled it
-retains its old value.
+retains its old value.  Each element in the fourth parameter is
+evaluated as an if-condition, so :ref:`Condition Syntax` can be used.
 #]=======================================================================]
 #]=======================================================================]
 
 
 macro(CMAKE_DEPENDENT_OPTION option doc default depends force)
 macro(CMAKE_DEPENDENT_OPTION option doc default depends force)