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

39 lines
1.6 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_path
---------
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_path
.. |NAMES| replace:: NAMES name1 [name2 ...]
.. |SEARCH_XXX| replace:: file in a directory
.. |SEARCH_XXX_DESC| replace:: directory containing the named file
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>/include``
.. |entry_XXX_SUBDIR| replace:: ``<entry>/include``
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::
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>/include/<arch>`` if :variable:`CMAKE_LIBRARY_ARCHITECTURE`
is set, and |CMAKE_PREFIX_PATH_XXX_SUBDIR|
.. |CMAKE_XXX_PATH| replace:: :variable:`CMAKE_INCLUDE_PATH`
.. |CMAKE_XXX_MAC_PATH| replace:: :variable:`CMAKE_FRAMEWORK_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:: Directories in ``INCLUDE``,
``<prefix>/include/<arch>`` if :variable:`CMAKE_LIBRARY_ARCHITECTURE`
is set, and |SYSTEM_ENVIRONMENT_PREFIX_PATH_XXX_SUBDIR|, and the
directories in ``PATH`` itself.
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::
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>/include/<arch>`` if :variable:`CMAKE_LIBRARY_ARCHITECTURE`
is set, and |CMAKE_SYSTEM_PREFIX_PATH_XXX_SUBDIR|
.. |CMAKE_SYSTEM_XXX_PATH| replace::
:variable:`CMAKE_SYSTEM_INCLUDE_PATH`
.. |CMAKE_SYSTEM_XXX_MAC_PATH| replace::
:variable:`CMAKE_SYSTEM_FRAMEWORK_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_INCLUDE`
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
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
When searching for frameworks, if the file is specified as ``A/b.h``, then
the framework search will look for ``A.framework/Headers/b.h``. If that
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
is found the path will be set to the path to the framework. CMake
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
will convert this to the correct ``-F`` option to include the file.