summaryrefslogtreecommitdiff
path: root/Modules/FindGit.cmake
diff options
context:
space:
mode:
authorKitware Robot <kwrobot@kitware.com>2013-10-15 11:17:36 -0400
committerBrad King <brad.king@kitware.com>2013-10-15 14:12:03 -0400
commitf051814ed0e63badbfd68049354f36259dbf4b49 (patch)
treef4e6f885f86c882d723a7dd53d2b702d0c7fdffb /Modules/FindGit.cmake
parente94958e99c4dec26c86ce8b76d744c04ba960675 (diff)
downloadcmake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.gz
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.
Diffstat (limited to 'Modules/FindGit.cmake')
-rw-r--r--Modules/FindGit.cmake27
1 files changed, 20 insertions, 7 deletions
diff --git a/Modules/FindGit.cmake b/Modules/FindGit.cmake
index 41d2a7a8c3..570538d7d4 100644
--- a/Modules/FindGit.cmake
+++ b/Modules/FindGit.cmake
@@ -1,12 +1,25 @@
+#.rst:
+# FindGit
+# -------
+#
+#
+#
# The module defines the following variables:
-# GIT_EXECUTABLE - path to git command line client
-# GIT_FOUND - true if the command line client was found
-# GIT_VERSION_STRING - the version of git found (since CMake 2.8.8)
+#
+# ::
+#
+# GIT_EXECUTABLE - path to git command line client
+# GIT_FOUND - true if the command line client was found
+# GIT_VERSION_STRING - the version of git found (since CMake 2.8.8)
+#
# Example usage:
-# find_package(Git)
-# if(GIT_FOUND)
-# message("git found: ${GIT_EXECUTABLE}")
-# endif()
+#
+# ::
+#
+# find_package(Git)
+# if(GIT_FOUND)
+# message("git found: ${GIT_EXECUTABLE}")
+# endif()
#=============================================================================
# Copyright 2010 Kitware, Inc.