mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-08 14:50:10 -06:00
Code Issues Packages Projects Releases Wiki Activity

FindCygwin, FindMsys: Update documentation

Browse Source 
This extends the modules documentation to clarify their intended usage
is for other find modules rather than in projects directly.
This commit is contained in:
Peter Kokot
2025-04-09 02:19:04 +02:00
parent 1840c8c61b
commit f95eb088ad
2 changed files with 74 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
Modules/FindCygwin.cmake
View File

@@ -5,8 +5,43 @@
FindCygwin
----------
Find Cygwin, a POSIX-compatible environment that runs natively
on Microsoft Windows
Finds Cygwin, a POSIX-compatible environment that runs natively on Microsoft
Windows.
.. note::
This module is primarily intended for use in other :ref:`Find Modules` to help
locate programs when using the ``find_*()`` commands, such as
:command:`find_program`. In most cases, direct use of those commands is
sufficient. Use this module only if a specific program is known to be
installed via Cygwin and is usable from Windows.
Result Variables
^^^^^^^^^^^^^^^^
This module defines the following variables:
``CYGWIN_INSTALL_PATH``
The path to the Cygwin root installation directory.
Examples
^^^^^^^^
Finding the Cygwin installation and using its path in a custom find module:
.. code-block:: cmake
:caption: FindFoo.cmake
find_package(Cygwin)
find_program(Foo_EXECUTABLE NAMES foo PATHS ${CYGWIN_INSTALL_PATH}/bin)
include(FindPackageHandleStandardArgs)
find_package_handle_standard_args(Foo REQUIRED_VARS Foo_EXECUTABLE)
See Also
^^^^^^^^
* The :module:`FindMsys` module to find MSYS path in a similar way.
#]=======================================================================]
if (WIN32)

39
Modules/FindMsys.cmake
View File

@@ -7,8 +7,43 @@ FindMsys
.. versionadded:: 3.21
Find MSYS, a POSIX-compatible environment that runs natively
on Microsoft Windows
Finds MSYS, a POSIX-compatible environment that runs natively on Microsoft
Windows.
.. note::
This module is primarily intended for use in other :ref:`Find Modules` to help
locate programs when using the ``find_*()`` commands, such as
:command:`find_program`. In most cases, direct use of those commands is
sufficient. Use this module only if a specific program is known to be
installed via MSYS and is usable from Windows.
Result Variables
^^^^^^^^^^^^^^^^
This module defines the following variables:
``MSYS_INSTALL_PATH``
The path to the MSYS root installation directory.
Examples
^^^^^^^^
Finding the MSYS installation and using its path in a custom find module:
.. code-block:: cmake
:caption: FindFoo.cmake
find_package(Msys)
find_program(Foo_EXECUTABLE NAMES foo PATHS ${MSYS_INSTALL_PATH}/usr/bin)
include(FindPackageHandleStandardArgs)
find_package_handle_standard_args(Foo REQUIRED_VARS Foo_EXECUTABLE)
See Also
^^^^^^^^
* The :module:`FindCygwin` module to find Cygwin path in a similar way.
#]=======================================================================]
if (WIN32)