summaryrefslogtreecommitdiffstats
path: root/Modules
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2016-02-01 15:43:54 (GMT)
committerCMake Topic Stage <kwrobot@kitware.com>2016-02-01 15:43:54 (GMT)
commit5ee96fc2724e2264d7ba804586da2f0bc759929d (patch)
treeace3aa4ac51e623ff4933266a8f3ba0ccc9c42e3 /Modules
parentc022b6f6862c67885401d24c438acac457c64f31 (diff)
parentfa78ee97ff30cc066a620cacdfe4144852947dc4 (diff)
downloadCMake-5ee96fc2724e2264d7ba804586da2f0bc759929d.zip
CMake-5ee96fc2724e2264d7ba804586da2f0bc759929d.tar.gz
CMake-5ee96fc2724e2264d7ba804586da2f0bc759929d.tar.bz2
Merge topic 'FindGit-updates'
fa78ee97 FindGit: Improve documentation formatting facfb52c FindGit: Document Git_FOUND, unset internal var
Diffstat (limited to 'Modules')
-rw-r--r--Modules/FindGit.cmake26
1 files changed, 13 insertions, 13 deletions
diff --git a/Modules/FindGit.cmake b/Modules/FindGit.cmake
index 2c3e5fd..d18f965 100644
--- a/Modules/FindGit.cmake
+++ b/Modules/FindGit.cmake
@@ -2,27 +2,26 @@
# 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``, ``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}")
+# if(Git_FOUND)
+# message("Git found: ${GIT_EXECUTABLE}")
# endif()
#=============================================================================
-# Copyright 2010 Kitware, Inc.
+# Copyright 2010-2016 Kitware, Inc.
# Copyright 2012 Rolf Eike Beer <eike@sf-mail.de>
#
# Distributed under the OSI-approved BSD License (the "License");
@@ -57,10 +56,11 @@ find_program(GIT_EXECUTABLE
NAMES ${git_names}
PATHS ${github_path} ${_git_sourcetree_path}
PATH_SUFFIXES Git/cmd Git/bin
- DOC "git command line client"
+ DOC "Git command line client"
)
mark_as_advanced(GIT_EXECUTABLE)
+unset(git_names)
unset(_git_sourcetree_path)
if(GIT_EXECUTABLE)
@@ -74,7 +74,7 @@ if(GIT_EXECUTABLE)
unset(git_version)
endif()
-# Handle the QUIETLY and REQUIRED arguments and set GIT_FOUND to TRUE if
+# Handle the QUIETLY and REQUIRED arguments and set Git_FOUND to TRUE if
# all listed variables are TRUE
include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake)