CMakeDetermineVSServicePack: Format documentation

Also state explicitly that the module is deprecated.
This commit is contained in:
Brad King 2014-04-10 11:01:46 -04:00
parent a48de7d850
commit 101515b958
1 changed files with 9 additions and 11 deletions

View File

@ -2,15 +2,15 @@
# CMakeDetermineVSServicePack # CMakeDetermineVSServicePack
# --------------------------- # ---------------------------
# #
# Deprecated. Do not use.
#
# The functionality of this module has been superseded by the
# :variable:`CMAKE_<LANG>_COMPILER_VERSION` variable that contains
# the compiler version number.
#
# Determine the Visual Studio service pack of the 'cl' in use. # Determine the Visual Studio service pack of the 'cl' in use.
# #
# The functionality of this module has been superseded by the platform # Usage::
# variable CMAKE_<LANG>_COMPILER_VERSION that contains the compiler
# version number.
#
# Usage:
#
# ::
# #
# if(MSVC) # if(MSVC)
# include(CMakeDetermineVSServicePack) # include(CMakeDetermineVSServicePack)
@ -21,14 +21,12 @@
# endif() # endif()
# #
# Function DetermineVSServicePack sets the given variable to one of the # Function DetermineVSServicePack sets the given variable to one of the
# following values or an empty string if unknown: # following values or an empty string if unknown::
#
# ::
# #
# vc80, vc80sp1 # vc80, vc80sp1
# vc90, vc90sp1 # vc90, vc90sp1
# vc100, vc100sp1 # vc100, vc100sp1
# vc110, vc110sp1, vc110sp2 # vc110, vc110sp1, vc110sp2, vc110sp3
#============================================================================= #=============================================================================
# Copyright 2009-2013 Kitware, Inc. # Copyright 2009-2013 Kitware, Inc.