kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
CMake/Help/command/find_program.rst

34 lines
1.2 KiB
ReStructuredText
Raw Normal View History

Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
find_program
------------
Help: Factor out find_* command duplication These documents were represented in the builtin documentation using a common starting point with placeholders substituted by each command. Convert them back to this approach using the reStructuredText include directive and substitutions to avoid duplication.
2013-10-01 20:37:02 +04:00
.. |FIND_XXX| replace:: find_program
find_program: Optionally consider all names in each directory When more than one value is given to the NAMES option this command by default will consider one name at a time and search every directory for it. Add a NAMES_PER_DIR option to tell this command to consider one directory at a time and search for all names in it.
2015-09-01 23:25:57 +03:00
.. |NAMES| replace:: NAMES name1 [name2 ...] [NAMES_PER_DIR]
Help: Factor out find_* command duplication These documents were represented in the builtin documentation using a common starting point with placeholders substituted by each command. Convert them back to this approach using the reStructuredText include directive and substitutions to avoid duplication.
2013-10-01 20:37:02 +04:00
.. |SEARCH_XXX| replace:: program
.. |SEARCH_XXX_DESC| replace:: program
Help: Improve documentation formatting of find_* commands Use inline reStructuredText markup and add cross-references in more places.
2015-06-08 22:52:21 +03:00
.. |prefix_XXX_SUBDIR| replace:: ``<prefix>/[s]bin``
.. |entry_XXX_SUBDIR| replace:: ``<entry>/[s]bin``
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
Help: Factor out find_* command duplication These documents were represented in the builtin documentation using a common starting point with placeholders substituted by each command. Convert them back to this approach using the reStructuredText include directive and substitutions to avoid duplication.
2013-10-01 20:37:02 +04:00
.. |CMAKE_PREFIX_PATH_XXX| replace::
|CMAKE_PREFIX_PATH_XXX_SUBDIR|
Help: Improve documentation formatting of find_* commands Use inline reStructuredText markup and add cross-references in more places.
2015-06-08 22:52:21 +03:00
.. |CMAKE_XXX_PATH| replace:: :variable:`CMAKE_PROGRAM_PATH`
.. |CMAKE_XXX_MAC_PATH| replace:: :variable:`CMAKE_APPBUNDLE_PATH`
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
Help: Improve documentation formatting of find_* commands Use inline reStructuredText markup and add cross-references in more places.
2015-06-08 22:52:21 +03:00
.. |SYSTEM_ENVIRONMENT_PATH_XXX| replace:: ``PATH``
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
Help: Factor out find_* command duplication These documents were represented in the builtin documentation using a common starting point with placeholders substituted by each command. Convert them back to this approach using the reStructuredText include directive and substitutions to avoid duplication.
2013-10-01 20:37:02 +04:00
.. |CMAKE_SYSTEM_PREFIX_PATH_XXX| replace::
|CMAKE_SYSTEM_PREFIX_PATH_XXX_SUBDIR|
Help: Improve documentation formatting of find_* commands Use inline reStructuredText markup and add cross-references in more places.
2015-06-08 22:52:21 +03:00
.. |CMAKE_SYSTEM_XXX_PATH| replace::
:variable:`CMAKE_SYSTEM_PROGRAM_PATH`
.. |CMAKE_SYSTEM_XXX_MAC_PATH| replace::
:variable:`CMAKE_SYSTEM_APPBUNDLE_PATH`
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
Help: Factor out find_* command duplication These documents were represented in the builtin documentation using a common starting point with placeholders substituted by each command. Convert them back to this approach using the reStructuredText include directive and substitutions to avoid duplication.
2013-10-01 20:37:02 +04:00
.. |CMAKE_FIND_ROOT_PATH_MODE_XXX| replace::
Help: Document the CMAKE_FIND_ROOT_PATH* variables. Add a replacement template for the variables, and link to them from the documentation for the find_* commands.
2013-11-26 22:58:07 +04:00
:variable:`CMAKE_FIND_ROOT_PATH_MODE_PROGRAM`
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
Help: Factor out find_* command duplication These documents were represented in the builtin documentation using a common starting point with placeholders substituted by each command. Convert them back to this approach using the reStructuredText include directive and substitutions to avoid duplication.
2013-10-01 20:37:02 +04:00
.. include:: FIND_XXX.txt
find_program: Optionally consider all names in each directory When more than one value is given to the NAMES option this command by default will consider one name at a time and search every directory for it. Add a NAMES_PER_DIR option to tell this command to consider one directory at a time and search for all names in it.
2015-09-01 23:25:57 +03:00
When more than one value is given to the ``NAMES`` option this command by
default will consider one name at a time and search every directory
for it. The ``NAMES_PER_DIR`` option tells this command to consider one
directory at a time and search for all names in it.