Browse Source

Merge topic 'FindGit-updates'

fa78ee97 FindGit: Improve documentation formatting
facfb52c FindGit: Document Git_FOUND, unset internal var
Brad King 9 năm trước cách đây
mục cha
commit
5ee96fc272
1 tập tin đã thay đổi với 13 bổ sung13 xóa
  1. 13 13
      Modules/FindGit.cmake

+ 13 - 13
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 <[email protected]>
 #
 # 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)