diff options
| author | Matthew Woehlke <matthew.woehlke@kitware.com> | 2022-09-30 18:50:25 (GMT) |
|---|---|---|
| committer | Matthew Woehlke <matthew.woehlke@kitware.com> | 2022-09-30 18:50:25 (GMT) |
| commit | 0f28653ba9dea36564dbd41388536982c56a96eb (patch) | |
| tree | f1655de6a7ed6c16a41eec3eb918a42ab9f9f006 /Help/command/try_compile.rst | |
| parent | cadcb6a5f0e1ebaefd74f8c52151e410c57cfa96 (diff) | |
| download | CMake-0f28653ba9dea36564dbd41388536982c56a96eb.zip CMake-0f28653ba9dea36564dbd41388536982c56a96eb.tar.gz CMake-0f28653ba9dea36564dbd41388536982c56a96eb.tar.bz2 | |
try_compile: Rename SOURCE_FROM_ARG -> SOURCE_FROM_CONTENT
Change the SOURCE_FROM_ARG keyword to try_compile to SOURCE_FROM_CONTENT
(which we can do because it was recently added and hasn't been in a
release yet). The new name should be clearer as to what it does, and
also more consistent with the CONTENT arguments to some other commands.
Also, fix a typo in an error message.
Diffstat (limited to 'Help/command/try_compile.rst')
| -rw-r--r-- | Help/command/try_compile.rst | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/Help/command/try_compile.rst b/Help/command/try_compile.rst index 6cb4f99..2f62917 100644 --- a/Help/command/try_compile.rst +++ b/Help/command/try_compile.rst @@ -59,10 +59,10 @@ Try Compiling Source Files .. code-block:: cmake try_compile(<resultVar> - <SOURCES <srcfile...>] | - SOURCE_FROM_ARG <name> <content>] | - SOURCE_FROM_VAR <name> <var>] | - SOURCE_FROM_FILE <name> <path> >... + <SOURCES <srcfile...>] | + SOURCE_FROM_CONTENT <name> <content>] | + SOURCE_FROM_VAR <name> <var>] | + SOURCE_FROM_FILE <name> <path> >... [NO_CACHE] [CMAKE_FLAGS <flags>...] [COMPILE_DEFINITIONS <defs>...] @@ -194,7 +194,7 @@ The options are: ``OUTPUT_VARIABLE <var>`` Store the output from the build process in the given variable. -``SOURCE_FROM_ARG <name> <content>`` +``SOURCE_FROM_CONTENT <name> <content>`` .. versionadded:: 3.25 Write ``<content>`` to a file named ``<name>`` in the operation directory. @@ -202,7 +202,7 @@ The options are: the contents of the file are dynamically specified. The specified ``<name>`` is not allowed to contain path components. - ``SOURCE_FROM_ARG`` may be specified multiple times. + ``SOURCE_FROM_CONTENT`` may be specified multiple times. ``SOURCE_FROM_FILE <name> <path>`` .. versionadded:: 3.25 @@ -218,10 +218,11 @@ The options are: .. versionadded:: 3.25 Write the contents of ``<var>`` to a file named ``<name>`` in the operation - directory. This is the same as ``SOURCE_FROM_ARG``, but takes the contents - from the specified CMake variable, rather than directly, which may be useful - when passing arguments through a function which wraps ``try_compile``. The - specified ``<name>`` is not allowed to contain path components. + directory. This is the same as ``SOURCE_FROM_CONTENT``, but takes the + contents from the specified CMake variable, rather than directly, which may + be useful when passing arguments through a function which wraps + ``try_compile``. The specified ``<name>`` is not allowed to contain path + components. ``SOURCE_FROM_VAR`` may be specified multiple times. |