diff options
| author | Brad King <brad.king@kitware.com> | 2017-02-10 14:55:46 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2017-02-10 15:43:30 (GMT) |
| commit | 30abf145fd48f50c26ee7553fd2512e59be97f25 (patch) | |
| tree | c81d6e73ce733dc7043f773e426b6ed4bee073d5 | |
| parent | 97917900d146acd55a7e453f477c52cd2e816eb3 (diff) | |
| download | CMake-30abf145fd48f50c26ee7553fd2512e59be97f25.zip CMake-30abf145fd48f50c26ee7553fd2512e59be97f25.tar.gz CMake-30abf145fd48f50c26ee7553fd2512e59be97f25.tar.bz2 | |
Help: Fix cmake code block warnings produced by Sphinx 1.4
Some of our "cmake" code blocks do not use fully valid CMake syntax
because they have placeholders for human reference. Sphinx has
never been able to properly lex and highlight these, but now warns.
Fix each block's syntax or change to a non-cmake block as appropriate.
| -rw-r--r-- | Help/command/if.rst | 6 | ||||
| -rw-r--r-- | Help/manual/cmake-developer.7.rst | 4 | ||||
| -rw-r--r-- | Help/manual/cmake-language.7.rst | 4 | ||||
| -rw-r--r-- | Modules/CMakePackageConfigHelpers.cmake | 6 |
4 files changed, 10 insertions, 10 deletions
diff --git a/Help/command/if.rst b/Help/command/if.rst index 0941029..2a087d0 100644 --- a/Help/command/if.rst +++ b/Help/command/if.rst @@ -9,17 +9,17 @@ Conditionally execute a group of commands. # then section. COMMAND1(ARGS ...) COMMAND2(ARGS ...) - ... + #... elseif(expression2) # elseif section. COMMAND1(ARGS ...) COMMAND2(ARGS ...) - ... + #... else(expression) # else section. COMMAND1(ARGS ...) COMMAND2(ARGS ...) - ... + #... endif(expression) Evaluates the given expression. If the result is true, the commands diff --git a/Help/manual/cmake-developer.7.rst b/Help/manual/cmake-developer.7.rst index 46b922b..f77d8c0 100644 --- a/Help/manual/cmake-developer.7.rst +++ b/Help/manual/cmake-developer.7.rst @@ -540,7 +540,7 @@ a :ref:`Line Comment` block of the form: or a :ref:`Bracket Comment` of the form: -.. code-block:: cmake +:: #[[.rst: <module-name> @@ -558,7 +558,7 @@ All such comments must start with ``#`` in the first column. For example, a ``Modules/Findxxx.cmake`` module may contain: -.. code-block:: cmake +:: # Distributed under the OSI-approved BSD 3-Clause License. See accompanying # file Copyright.txt or https://cmake.org/licensing for details. diff --git a/Help/manual/cmake-language.7.rst b/Help/manual/cmake-language.7.rst index 41542c9..ba0b30f 100644 --- a/Help/manual/cmake-language.7.rst +++ b/Help/manual/cmake-language.7.rst @@ -255,7 +255,7 @@ invocation as exactly one argument. For example: -.. code-block:: cmake +:: message("This is a quoted argument containing multiple lines. This is always one argument even though it contains a ; character. @@ -421,7 +421,7 @@ A ``#`` immediately followed by a `Bracket Argument`_ forms a For example: -.. code-block:: cmake +:: #[[This is a bracket comment. It runs until the close bracket.]] diff --git a/Modules/CMakePackageConfigHelpers.cmake b/Modules/CMakePackageConfigHelpers.cmake index 3210222..90c2a57 100644 --- a/Modules/CMakePackageConfigHelpers.cmake +++ b/Modules/CMakePackageConfigHelpers.cmake @@ -40,7 +40,7 @@ # set(FOO_INCLUDE_DIR "@CMAKE_INSTALL_FULL_INCLUDEDIR@" ) # set(FOO_DATA_DIR "@CMAKE_INSTALL_PREFIX@/@RELATIVE_DATA_INSTALL_DIR@" ) # set(FOO_ICONS_DIR "@CMAKE_INSTALL_PREFIX@/share/icons" ) -# ...logic to determine installedPrefix from the own location... +# #...logic to determine installedPrefix from the own location... # set(FOO_CONFIG_DIR "${installedPrefix}/@CONFIG_INSTALL_DIR@" ) # # All 4 options shown above are not sufficient, since the first 3 hardcode the @@ -174,7 +174,7 @@ # set(INCLUDE_INSTALL_DIR include/ ... CACHE ) # set(LIB_INSTALL_DIR lib/ ... CACHE ) # set(SYSCONFIG_INSTALL_DIR etc/foo/ ... CACHE ) -# ... +# #... # include(CMakePackageConfigHelpers) # configure_package_config_file(FooConfig.cmake.in # ${CMAKE_CURRENT_BINARY_DIR}/FooConfig.cmake @@ -190,7 +190,7 @@ # # ``FooConfig.cmake.in``: # -# .. code-block:: cmake +# :: # # set(FOO_VERSION x.y.z) # ... |