mirror of
https://github.com/Kitware/CMake.git
synced 2025-10-14 10:47:59 +08:00
Help: Remove stray spaces and one colon
This commit is contained in:
@@ -11,8 +11,8 @@ The general signature is:
|
|||||||
|FIND_XXX| (
|
|FIND_XXX| (
|
||||||
<VAR>
|
<VAR>
|
||||||
name | |NAMES|
|
name | |NAMES|
|
||||||
[HINTS [path | ENV var]... ]
|
[HINTS [path | ENV var]...]
|
||||||
[PATHS [path | ENV var]... ]
|
[PATHS [path | ENV var]...]
|
||||||
[REGISTRY_VIEW (64|32|64_32|32_64|HOST|TARGET|BOTH)]
|
[REGISTRY_VIEW (64|32|64_32|32_64|HOST|TARGET|BOTH)]
|
||||||
[PATH_SUFFIXES suffix1 [suffix2 ...]]
|
[PATH_SUFFIXES suffix1 [suffix2 ...]]
|
||||||
[VALIDATOR function]
|
[VALIDATOR function]
|
||||||
|
@@ -7,7 +7,7 @@ Add a target with no output so it will always be built.
|
|||||||
|
|
||||||
add_custom_target(Name [ALL] [command1 [args1...]]
|
add_custom_target(Name [ALL] [command1 [args1...]]
|
||||||
[COMMAND command2 [args2...] ...]
|
[COMMAND command2 [args2...] ...]
|
||||||
[DEPENDS depend depend depend ... ]
|
[DEPENDS depend depend depend ...]
|
||||||
[BYPRODUCTS [files...]]
|
[BYPRODUCTS [files...]]
|
||||||
[WORKING_DIRECTORY dir]
|
[WORKING_DIRECTORY dir]
|
||||||
[COMMENT comment]
|
[COMMENT comment]
|
||||||
|
@@ -7,7 +7,7 @@ Evaluate a group of commands with a dedicated variable and/or policy scope.
|
|||||||
|
|
||||||
.. code-block:: cmake
|
.. code-block:: cmake
|
||||||
|
|
||||||
block([SCOPE_FOR [POLICIES] [VARIABLES] ] [PROPAGATE <var-name>...])
|
block([SCOPE_FOR [POLICIES] [VARIABLES]] [PROPAGATE <var-name>...])
|
||||||
<commands>
|
<commands>
|
||||||
endblock()
|
endblock()
|
||||||
|
|
||||||
|
@@ -13,7 +13,7 @@ Copy a file to another location and modify its contents.
|
|||||||
[NO_SOURCE_PERMISSIONS | USE_SOURCE_PERMISSIONS |
|
[NO_SOURCE_PERMISSIONS | USE_SOURCE_PERMISSIONS |
|
||||||
FILE_PERMISSIONS <permissions>...]
|
FILE_PERMISSIONS <permissions>...]
|
||||||
[COPYONLY] [ESCAPE_QUOTES] [@ONLY]
|
[COPYONLY] [ESCAPE_QUOTES] [@ONLY]
|
||||||
[NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ])
|
[NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF]])
|
||||||
|
|
||||||
Copies an ``<input>`` file to an ``<output>`` file while performing
|
Copies an ``<input>`` file to an ``<output>`` file while performing
|
||||||
`transformations`_ of the input file content.
|
`transformations`_ of the input file content.
|
||||||
|
@@ -211,7 +211,7 @@ Writing
|
|||||||
[CONDITION <expression>] [TARGET <target>]
|
[CONDITION <expression>] [TARGET <target>]
|
||||||
[NO_SOURCE_PERMISSIONS | USE_SOURCE_PERMISSIONS |
|
[NO_SOURCE_PERMISSIONS | USE_SOURCE_PERMISSIONS |
|
||||||
FILE_PERMISSIONS <permissions>...]
|
FILE_PERMISSIONS <permissions>...]
|
||||||
[NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ])
|
[NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF]])
|
||||||
|
|
||||||
The options are:
|
The options are:
|
||||||
|
|
||||||
@@ -293,7 +293,7 @@ Writing
|
|||||||
file(CONFIGURE OUTPUT <output-file>
|
file(CONFIGURE OUTPUT <output-file>
|
||||||
CONTENT <content>
|
CONTENT <content>
|
||||||
[ESCAPE_QUOTES] [@ONLY]
|
[ESCAPE_QUOTES] [@ONLY]
|
||||||
[NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ])
|
[NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF]])
|
||||||
:target: CONFIGURE
|
:target: CONFIGURE
|
||||||
|
|
||||||
.. versionadded:: 3.18
|
.. versionadded:: 3.18
|
||||||
|
@@ -260,8 +260,8 @@ Full Signature
|
|||||||
[BYPASS_PROVIDER]
|
[BYPASS_PROVIDER]
|
||||||
[NAMES name1 [name2 ...]]
|
[NAMES name1 [name2 ...]]
|
||||||
[CONFIGS config1 [config2 ...]]
|
[CONFIGS config1 [config2 ...]]
|
||||||
[HINTS path1 [path2 ... ]]
|
[HINTS path1 [path2 ...]]
|
||||||
[PATHS path1 [path2 ... ]]
|
[PATHS path1 [path2 ...]]
|
||||||
[REGISTRY_VIEW (64|32|64_32|32_64|HOST|TARGET|BOTH)]
|
[REGISTRY_VIEW (64|32|64_32|32_64|HOST|TARGET|BOTH)]
|
||||||
[PATH_SUFFIXES suffix1 [suffix2 ...]]
|
[PATH_SUFFIXES suffix1 [suffix2 ...]]
|
||||||
[NO_DEFAULT_PATH]
|
[NO_DEFAULT_PATH]
|
||||||
|
@@ -6,7 +6,7 @@ Create FLTK user interfaces Wrappers.
|
|||||||
.. code-block:: cmake
|
.. code-block:: cmake
|
||||||
|
|
||||||
fltk_wrap_ui(resultingLibraryName source1
|
fltk_wrap_ui(resultingLibraryName source1
|
||||||
source2 ... sourceN )
|
source2 ... sourceN)
|
||||||
|
|
||||||
Produce .h and .cxx files for all the .fl and .fld files listed. The
|
Produce .h and .cxx files for all the .fl and .fld files listed. The
|
||||||
resulting .h and .cxx files will be added to a variable named
|
resulting .h and .cxx files will be added to a variable named
|
||||||
|
@@ -236,7 +236,7 @@ For more information on regular expressions look under
|
|||||||
list(TRANSFORM <list> GENEX_STRIP ...)
|
list(TRANSFORM <list> GENEX_STRIP ...)
|
||||||
:target: TRANSFORM_GENEX_STRIP
|
:target: TRANSFORM_GENEX_STRIP
|
||||||
|
|
||||||
:command:`REPLACE <string(REGEX REPLACE)>`:
|
:command:`REPLACE <string(REGEX REPLACE)>`
|
||||||
Match the regular expression as many times as possible and substitute
|
Match the regular expression as many times as possible and substitute
|
||||||
the replacement expression for the match for each element of the list
|
the replacement expression for the match for each element of the list
|
||||||
(same semantic as :command:`string(REGEX REPLACE)`).
|
(same semantic as :command:`string(REGEX REPLACE)`).
|
||||||
|
@@ -10,7 +10,7 @@ Add a list of subdirectories to the build.
|
|||||||
.. code-block:: cmake
|
.. code-block:: cmake
|
||||||
|
|
||||||
subdirs(dir1 dir2 ...[EXCLUDE_FROM_ALL exclude_dir1 exclude_dir2 ...]
|
subdirs(dir1 dir2 ...[EXCLUDE_FROM_ALL exclude_dir1 exclude_dir2 ...]
|
||||||
[PREORDER] )
|
[PREORDER])
|
||||||
|
|
||||||
Add a list of subdirectories to the build. The :command:`add_subdirectory`
|
Add a list of subdirectories to the build. The :command:`add_subdirectory`
|
||||||
command should be used instead of ``subdirs`` although ``subdirs`` will still
|
command should be used instead of ``subdirs`` although ``subdirs`` will still
|
||||||
|
@@ -526,7 +526,7 @@ List of CPack RPM generator specific variables:
|
|||||||
|
|
||||||
May be set by the user in order to specify a USER binary spec file
|
May be set by the user in order to specify a USER binary spec file
|
||||||
to be used by the CPack RPM generator instead of generating the file.
|
to be used by the CPack RPM generator instead of generating the file.
|
||||||
The specified file will be processed by configure_file( @ONLY).
|
The specified file will be processed by configure_file(@ONLY).
|
||||||
|
|
||||||
.. variable:: CPACK_RPM_GENERATE_USER_BINARY_SPECFILE_TEMPLATE
|
.. variable:: CPACK_RPM_GENERATE_USER_BINARY_SPECFILE_TEMPLATE
|
||||||
|
|
||||||
|
@@ -319,7 +319,7 @@ were built in its own tree. For example:
|
|||||||
|
|
||||||
include(GNUInstallDirs)
|
include(GNUInstallDirs)
|
||||||
include(${INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}/cmake/MathFunctions/MathFunctionTargets.cmake)
|
include(${INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}/cmake/MathFunctions/MathFunctionTargets.cmake)
|
||||||
add_executable(myexe src1.c src2.c )
|
add_executable(myexe src1.c src2.c)
|
||||||
target_link_libraries(myexe PRIVATE MathFunctions::MathFunctions)
|
target_link_libraries(myexe PRIVATE MathFunctions::MathFunctions)
|
||||||
|
|
||||||
Line 2 loads the target CMake file. Although we only exported a single
|
Line 2 loads the target CMake file. Although we only exported a single
|
||||||
|
@@ -121,7 +121,7 @@ install(FILES
|
|||||||
)
|
)
|
||||||
|
|
||||||
# generate the export targets for the build tree
|
# generate the export targets for the build tree
|
||||||
# needs to be after the install(TARGETS ) command
|
# needs to be after the install(TARGETS) command
|
||||||
export(EXPORT MathFunctionsTargets
|
export(EXPORT MathFunctionsTargets
|
||||||
FILE "${CMAKE_CURRENT_BINARY_DIR}/MathFunctionsTargets.cmake"
|
FILE "${CMAKE_CURRENT_BINARY_DIR}/MathFunctionsTargets.cmake"
|
||||||
)
|
)
|
||||||
|
@@ -405,7 +405,7 @@ Options
|
|||||||
|
|
||||||
``json-v1``
|
``json-v1``
|
||||||
Prints each line as a separate JSON document. Each document is
|
Prints each line as a separate JSON document. Each document is
|
||||||
separated by a newline ( ``\n`` ). It is guaranteed that no
|
separated by a newline (``\n``). It is guaranteed that no
|
||||||
newline characters will be present inside a JSON document.
|
newline characters will be present inside a JSON document.
|
||||||
|
|
||||||
.. code-block:: json
|
.. code-block:: json
|
||||||
|
@@ -21,4 +21,4 @@ determine the widget type. Valid ``TYPE`` values are:
|
|||||||
================= ========================================
|
================= ========================================
|
||||||
|
|
||||||
Generally the ``TYPE`` of a cache entry should be set by the command which
|
Generally the ``TYPE`` of a cache entry should be set by the command which
|
||||||
creates it ( :command:`set`, :command:`option`, :command:`find_library`, etc.).
|
creates it (:command:`set`, :command:`option`, :command:`find_library`, etc.).
|
||||||
|
@@ -58,7 +58,7 @@ In ``CMakeLists.txt`` we add a filter to
|
|||||||
|
|
||||||
.. code-block:: c++
|
.. code-block:: c++
|
||||||
|
|
||||||
list( APPEND CMAKE_AUTOMOC_DEPEND_FILTERS
|
list(APPEND CMAKE_AUTOMOC_DEPEND_FILTERS
|
||||||
"JSON_FILE_MACRO"
|
"JSON_FILE_MACRO"
|
||||||
"[\n][ \t]*JSON_FILE_MACRO[ \t]*\\([ \t]*\"([^\"]+)\""
|
"[\n][ \t]*JSON_FILE_MACRO[ \t]*\\([ \t]*\"([^\"]+)\""
|
||||||
)
|
)
|
||||||
|
@@ -21,8 +21,8 @@ Usage:
|
|||||||
|
|
||||||
if(MSVC)
|
if(MSVC)
|
||||||
include(CMakeDetermineVSServicePack)
|
include(CMakeDetermineVSServicePack)
|
||||||
DetermineVSServicePack( my_service_pack )
|
DetermineVSServicePack(my_service_pack)
|
||||||
if( my_service_pack )
|
if(my_service_pack)
|
||||||
message(STATUS "Detected: ${my_service_pack}")
|
message(STATUS "Detected: ${my_service_pack}")
|
||||||
endif()
|
endif()
|
||||||
endif()
|
endif()
|
||||||
|
@@ -12,7 +12,7 @@ WriteBasicConfigVersionFile
|
|||||||
|
|
||||||
.. code-block:: cmake
|
.. code-block:: cmake
|
||||||
|
|
||||||
WRITE_BASIC_CONFIG_VERSION_FILE( filename
|
WRITE_BASIC_CONFIG_VERSION_FILE(filename
|
||||||
[VERSION major.minor.patch]
|
[VERSION major.minor.patch]
|
||||||
COMPATIBILITY (AnyNewerVersion|SameMajorVersion|SameMinorVersion|ExactVersion)
|
COMPATIBILITY (AnyNewerVersion|SameMajorVersion|SameMinorVersion|ExactVersion)
|
||||||
[ARCH_INDEPENDENT]
|
[ARCH_INDEPENDENT]
|
||||||
|
Reference in New Issue
Block a user