diff options
| author | Craig Scott <craig.scott@crascit.com> | 2018-02-11 10:04:26 (GMT) |
|---|---|---|
| committer | Craig Scott <craig.scott@crascit.com> | 2018-02-11 10:04:26 (GMT) |
| commit | a71ab3be0e668731885740a11d29d378069d9677 (patch) | |
| tree | 77eaa43588aedac136026cc56a61ddbaa9971b37 | |
| parent | e24cda008e3ea1cbb22d17d29c5c39999facb4b7 (diff) | |
| download | CMake-a71ab3be0e668731885740a11d29d378069d9677.zip CMake-a71ab3be0e668731885740a11d29d378069d9677.tar.gz CMake-a71ab3be0e668731885740a11d29d378069d9677.tar.bz2 | |
Help: Expand string(MAKE_C_IDENTIFIER) docs
The MAKE_C_IDENTIFIER subcommand was also buried in the docs for the
TIMESTAMP subcommand, so it has been pulled out to its own subheading.
| -rw-r--r-- | Help/command/string.rst | 19 | ||||
| -rw-r--r-- | Help/manual/cmake-generator-expressions.7.rst | 3 |
2 files changed, 14 insertions, 8 deletions
diff --git a/Help/command/string.rst b/Help/command/string.rst index fb3893f..d8da7be 100644 --- a/Help/command/string.rst +++ b/Help/command/string.rst @@ -282,6 +282,18 @@ CONFIGURE Transform a string like :command:`configure_file` transforms a file. +MAKE_C_IDENTIFIER +""""""""""""""""" + +:: + + string(MAKE_C_IDENTIFIER <input string> <output variable>) + +Convert each non-alphanumeric character in the ``<input string>`` to an +underscore and store the result in the ``<output variable>``. If the first +character of the string is a digit, an underscore will also be prepended to +the result. + RANDOM """""" @@ -346,13 +358,6 @@ If no explicit ``<format string>`` is given it will default to: %Y-%m-%dT%H:%M:%S for local time. %Y-%m-%dT%H:%M:%SZ for UTC. - -:: - - string(MAKE_C_IDENTIFIER <input string> <output variable>) - -Write a string which can be used as an identifier in C. - .. note:: If the ``SOURCE_DATE_EPOCH`` environment variable is set, diff --git a/Help/manual/cmake-generator-expressions.7.rst b/Help/manual/cmake-generator-expressions.7.rst index 0f6d4cf..13948d3 100644 --- a/Help/manual/cmake-generator-expressions.7.rst +++ b/Help/manual/cmake-generator-expressions.7.rst @@ -289,7 +289,8 @@ Available output expressions are: ``$<UPPER_CASE:...>`` Content of ``...`` converted to upper case. ``$<MAKE_C_IDENTIFIER:...>`` - Content of ``...`` converted to a C identifier. + Content of ``...`` converted to a C identifier. The conversion follows the + same behavior as :command:`string(MAKE_C_IDENTIFIER)`. ``$<TARGET_OBJECTS:objLib>`` List of objects resulting from build of ``objLib``. ``objLib`` must be an object of type ``OBJECT_LIBRARY``. |