summaryrefslogtreecommitdiffstats
path: root/Modules/CMakeDetermineVSServicePack.cmake
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-06-21 12:48:58 (GMT)
committerBrad King <brad.king@kitware.com>2013-06-21 12:48:58 (GMT)
commit1746a35df115e66a266481020591de231bfdfdf2 (patch)
treeb74e864f48d642060c50039ea1f1b0089077cb8f /Modules/CMakeDetermineVSServicePack.cmake
parent9f160c5b0a7e0f821ca4737638edbebf0ed398be (diff)
downloadCMake-1746a35df115e66a266481020591de231bfdfdf2.zip
CMake-1746a35df115e66a266481020591de231bfdfdf2.tar.gz
CMake-1746a35df115e66a266481020591de231bfdfdf2.tar.bz2
CMakeDetermineVSServicePack: Improve documentation
Refer users to the newer CMAKE_<LANG>_COMPILER_VERSION variables. Use a more concise summary. Format the documentation to look better in the "cmake --help-module" output.
Diffstat (limited to 'Modules/CMakeDetermineVSServicePack.cmake')
-rw-r--r--Modules/CMakeDetermineVSServicePack.cmake41
1 files changed, 17 insertions, 24 deletions
diff --git a/Modules/CMakeDetermineVSServicePack.cmake b/Modules/CMakeDetermineVSServicePack.cmake
index 98e5bb8..26c8ac0 100644
--- a/Modules/CMakeDetermineVSServicePack.cmake
+++ b/Modules/CMakeDetermineVSServicePack.cmake
@@ -1,32 +1,25 @@
-# - Includes a public function for assisting users in trying to determine the
-# Visual Studio service pack in use.
-#
-# Sets the passed in variable to one of the following values or an empty
-# string if unknown.
-# vc80
-# vc80sp1
-# vc90
-# vc90sp1
-# vc100
-# vc100sp1
-# vc110
+# - Determine the Visual Studio service pack of the 'cl' in use.
+# The functionality of this module has been superseded by the platform
+# variable CMAKE_<LANG>_COMPILER_VERSION that contains the compiler version
+# number.
#
# Usage:
-# ===========================
-#
-# if(MSVC)
-# include(CMakeDetermineVSServicePack)
-# DetermineVSServicePack( my_service_pack )
-#
-# if( my_service_pack )
-# message(STATUS "Detected: ${my_service_pack}")
-# endif()
+# if(MSVC)
+# include(CMakeDetermineVSServicePack)
+# DetermineVSServicePack( my_service_pack )
+# if( my_service_pack )
+# message(STATUS "Detected: ${my_service_pack}")
# endif()
-#
-# ===========================
+# endif()
+# Function DetermineVSServicePack sets the given variable to one of the
+# following values or an empty string if unknown:
+# vc80, vc80sp1
+# vc90, vc90sp1
+# vc100, vc100sp1
+# vc110
#=============================================================================
-# Copyright 2009-2011 Kitware, Inc.
+# Copyright 2009-2013 Kitware, Inc.
# Copyright 2009-2010 Philip Lowman <philip@yhbt.com>
# Copyright 2010-2011 Aaron C. meadows <cmake@shadowguarddev.com>
#