diff options
| author | DongHun Kwak <dh0128.kwak@samsung.com> | 2021-10-08 09:13:45 +0900 |
|---|---|---|
| committer | DongHun Kwak <dh0128.kwak@samsung.com> | 2021-10-08 09:13:45 +0900 |
| commit | fa10a4a91520c9add2283a053dd755a7e5db9f4b (patch) | |
| tree | b4c33311cdf36a37e72e3c4bd013e59b42a815f6 /Modules/FindHg.cmake | |
| parent | 4ca455f44f42bf3257fe1ce752ca7447e9568a27 (diff) | |
| download | cmake-fa10a4a91520c9add2283a053dd755a7e5db9f4b.tar.gz cmake-fa10a4a91520c9add2283a053dd755a7e5db9f4b.tar.bz2 cmake-fa10a4a91520c9add2283a053dd755a7e5db9f4b.zip | |
Imported Upstream version 3.14.1upstream/3.14.1
Diffstat (limited to 'Modules/FindHg.cmake')
| -rw-r--r-- | Modules/FindHg.cmake | 79 |
1 files changed, 40 insertions, 39 deletions
diff --git a/Modules/FindHg.cmake b/Modules/FindHg.cmake index 8aa553e79..1358363d2 100644 --- a/Modules/FindHg.cmake +++ b/Modules/FindHg.cmake @@ -1,45 +1,46 @@ # Distributed under the OSI-approved BSD 3-Clause License. See accompanying # file Copyright.txt or https://cmake.org/licensing for details. -#.rst: -# FindHg -# ------ -# -# Extract information from a mercurial working copy. -# -# The module defines the following variables: -# -# :: -# -# HG_EXECUTABLE - path to mercurial command line client (hg) -# HG_FOUND - true if the command line client was found -# HG_VERSION_STRING - the version of mercurial found -# -# If the command line client executable is found the following macro is defined: -# -# :: -# -# HG_WC_INFO(<dir> <var-prefix>) -# -# Hg_WC_INFO extracts information of a mercurial working copy -# at a given location. This macro defines the following variables: -# -# :: -# -# <var-prefix>_WC_CHANGESET - current changeset -# <var-prefix>_WC_REVISION - current revision -# -# Example usage: -# -# :: -# -# find_package(Hg) -# if(HG_FOUND) -# message("hg found: ${HG_EXECUTABLE}") -# HG_WC_INFO(${PROJECT_SOURCE_DIR} Project) -# message("Current revision is ${Project_WC_REVISION}") -# message("Current changeset is ${Project_WC_CHANGESET}") -# endif() +#[=======================================================================[.rst: +FindHg +------ + +Extract information from a mercurial working copy. + +The module defines the following variables: + +:: + + HG_EXECUTABLE - path to mercurial command line client (hg) + HG_FOUND - true if the command line client was found + HG_VERSION_STRING - the version of mercurial found + +If the command line client executable is found the following macro is defined: + +:: + + HG_WC_INFO(<dir> <var-prefix>) + +Hg_WC_INFO extracts information of a mercurial working copy +at a given location. This macro defines the following variables: + +:: + + <var-prefix>_WC_CHANGESET - current changeset + <var-prefix>_WC_REVISION - current revision + +Example usage: + +:: + + find_package(Hg) + if(HG_FOUND) + message("hg found: ${HG_EXECUTABLE}") + HG_WC_INFO(${PROJECT_SOURCE_DIR} Project) + message("Current revision is ${Project_WC_REVISION}") + message("Current changeset is ${Project_WC_CHANGESET}") + endif() +#]=======================================================================] find_program(HG_EXECUTABLE NAMES hg |