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

FindHg: Sync module documentation

Browse Source 
- Added intro code block with find_package() showing how to find the
  package with this module.
- Used "command" instead of "macro".
- Synced descriptions with other similar find modules.
This commit is contained in:
Peter Kokot
2025-05-12 23:21:18 +02:00
parent 4802077fb9
commit 50769f3f10
2 changed files with 12 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Help/release/3.1.rst
View File

@@ -235,7 +235,7 @@ Modules
* The :module:`FindGLUT` module now provides imported targets. * The :module:`FindGLUT` module now provides imported targets.
* The :module:`FindHg` module gained a new ``Hg_WC_INFO`` macro to * The :module:`FindHg` module gained a new ``Hg_WC_INFO`` command to
help run ``hg`` to extract information about a Mercurial work copy. help run ``hg`` to extract information about a Mercurial work copy.
* The :module:`FindOpenCL` module was introduced. * The :module:`FindOpenCL` module was introduced.

17
Modules/FindHg.cmake
View File

@@ -6,16 +6,21 @@ FindHg
------ ------
Finds the Mercurial command-line client executable (``hg``) and provides a Finds the Mercurial command-line client executable (``hg``) and provides a
command for extracting information from a Mercurial working copy. command for extracting information from a Mercurial working copy:
.. code-block:: cmake
find_package(Hg [<version>] [...])
Result Variables Result Variables
^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^
This module sets the following variables: This module defines the following variables:
``Hg_FOUND`` ``Hg_FOUND``
Boolean indicating whether the Mercurial client was found. For backward Boolean indicating whether (the requested version of) Mercurial client is
compatibility, the ``HG_FOUND`` variable is also set to the same value. found. For backward compatibility, the ``HG_FOUND`` variable is also set
to the same value.
``HG_VERSION_STRING`` ``HG_VERSION_STRING``
The version of Mercurial found. The version of Mercurial found.
@@ -31,7 +36,7 @@ The following cache variables may also be set:
Commands Commands
^^^^^^^^ ^^^^^^^^
This module defines the following command when Mercurial client (``hg``) is This module provides the following command when Mercurial client (``hg``) is
found: found:
.. command:: Hg_WC_INFO .. command:: Hg_WC_INFO
@@ -44,7 +49,7 @@ found:
Hg_WC_INFO(<dir> <var-prefix>) Hg_WC_INFO(<dir> <var-prefix>)
This macro defines the following variables if running Mercurial client on This command defines the following variables if running Mercurial client on
working copy located at a given location ``<dir>`` succeeds; otherwise a working copy located at a given location ``<dir>`` succeeds; otherwise a
``SEND_ERROR`` message is generated: ``SEND_ERROR`` message is generated: