summaryrefslogtreecommitdiffstats
path: root/Modules/FindGit.cmake
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2018-10-23 14:24:02 (GMT)
committerKitware Robot <kwrobot@kitware.com>2018-10-23 14:24:09 (GMT)
commitafd928f85a845fbaea8d00b69a8e75e2fdfbaeeb (patch)
treea9018c134cdd311fdcb793753e0d0835d98ad647 /Modules/FindGit.cmake
parent59662112396210bf35b5a9cc44a23d96cee955c9 (diff)
parent75f73dde0f2ebb14f1cc381ccc48fd3d41a31bc1 (diff)
downloadCMake-afd928f85a845fbaea8d00b69a8e75e2fdfbaeeb.zip
CMake-afd928f85a845fbaea8d00b69a8e75e2fdfbaeeb.tar.gz
CMake-afd928f85a845fbaea8d00b69a8e75e2fdfbaeeb.tar.bz2
Merge topic 'rst-block-comments'
75f73dde0f Utilities/Scripts: Remove temporary block-style comment conversion script df4ed1e9ff Help: Convert remaining modules to block-style comments 7115aa6c22 Utilities/Scripts: Add temporary block-style comment conversion script Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !2510
Diffstat (limited to 'Modules/FindGit.cmake')
-rw-r--r--Modules/FindGit.cmake43
1 files changed, 22 insertions, 21 deletions
diff --git a/Modules/FindGit.cmake b/Modules/FindGit.cmake
index fae31eb..c447a1a 100644
--- a/Modules/FindGit.cmake
+++ b/Modules/FindGit.cmake
@@ -1,27 +1,28 @@
# Distributed under the OSI-approved BSD 3-Clause License. See accompanying
# file Copyright.txt or https://cmake.org/licensing for details.
-#.rst:
-# FindGit
-# -------
-#
-# The module defines the following variables:
-#
-# ``GIT_EXECUTABLE``
-# Path to Git command-line client.
-# ``Git_FOUND``, ``GIT_FOUND``
-# True if the Git command-line client was found.
-# ``GIT_VERSION_STRING``
-# The version of Git found.
-#
-# Example usage:
-#
-# .. code-block:: cmake
-#
-# find_package(Git)
-# if(Git_FOUND)
-# message("Git found: ${GIT_EXECUTABLE}")
-# endif()
+#[=======================================================================[.rst:
+FindGit
+-------
+
+The module defines the following variables:
+
+``GIT_EXECUTABLE``
+ Path to Git command-line client.
+``Git_FOUND``, ``GIT_FOUND``
+ True if the Git command-line client was found.
+``GIT_VERSION_STRING``
+ The version of Git found.
+
+Example usage:
+
+.. code-block:: cmake
+
+ find_package(Git)
+ if(Git_FOUND)
+ message("Git found: ${GIT_EXECUTABLE}")
+ endif()
+#]=======================================================================]
# Look for 'git' or 'eg' (easy git)
#