diff options
| author | Alexander Neumann <alexander.neumann@hamburg.de> | 2019-08-08 14:40:47 +0200 |
|---|---|---|
| committer | Alexander Neumann <alexander.neumann@hamburg.de> | 2019-08-08 14:40:47 +0200 |
| commit | 5899cd1d25c134f8a30476f4939ab57952c59815 (patch) | |
| tree | a0996af9cda3cd9ad113a3f9c3a2fb18e21ad69c /scripts | |
| parent | b72fa4561f31c4ea6cdc733094cebf72bedff854 (diff) | |
| download | vcpkg-5899cd1d25c134f8a30476f4939ab57952c59815.tar.gz vcpkg-5899cd1d25c134f8a30476f4939ab57952c59815.zip | |
improve documentation
Diffstat (limited to 'scripts')
| -rw-r--r-- | scripts/cmake/vcpkg_common_definitions.cmake | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/scripts/cmake/vcpkg_common_definitions.cmake b/scripts/cmake/vcpkg_common_definitions.cmake index f43780959..d9b397fa1 100644 --- a/scripts/cmake/vcpkg_common_definitions.cmake +++ b/scripts/cmake/vcpkg_common_definitions.cmake @@ -1,3 +1,15 @@ +## # vcpkg_common_definitions
+##
+## File contains helpful variabls for portfiles which are commonly needed or used.
+##
+## ## The following variables are available:
+## ```cmake
+## VCPKG_TARGET_IS_<target> with <target> being one of the following: WINDOWS, UWP, LINUX, OSX, ANDROID, FREEBSD. only defined if <target>
+## VCPKG_HOST_PATH_SEPARATOR Host specific path separator
+## VCPKG_HOST_PATH_SEPARATOR_ESCAPED Escaped version of VCPKG_HOST_PATH_SEPARATOR if necessary (e.g. symbol with special meaning in cmake like ";")
+## ```
+##
+
#Helper variable to identify the Target system. VCPKG_TARGET_IS_<targetname>
if (NOT VCPKG_CMAKE_SYSTEM_NAME OR VCPKG_CMAKE_SYSTEM_NAME STREQUAL "WindowsStore")
set(VCPKG_TARGET_IS_WINDOWS 1)
@@ -14,7 +26,7 @@ elseif(VCPKG_CMAKE_SYSTEM_NAME STREQUAL "FreeBSD") set(VCPKG_TARGET_IS_FREEBSD 1)
endif()
-#Helper variable to identify the host path seperator.
+#Helper variable to identify the host path separator.
if(CMAKE_HOST_WIN32)
set(VCPKG_HOST_PATH_SEPARATOR ";")
set(VCPKG_HOST_PATH_SEPARATOR_ESCAPED "\\;") #sometimes needed to differentiate between the cmake list separator
|