aboutsummaryrefslogtreecommitdiff
path: root/scripts/cmake/vcpkg_find_acquire_program.cmake
diff options
context:
space:
mode:
authorRobert Schumacher <roschuma@microsoft.com>2017-05-28 14:20:32 -0700
committerGitHub <noreply@github.com>2017-05-28 14:20:32 -0700
commit39b69e5b06df309b9dcfea55296a4c2c3eea93ce (patch)
tree6fcbc7ef1752c45270abfe21eabd5452876462d8 /scripts/cmake/vcpkg_find_acquire_program.cmake
parente95a0986962405ab5b6e2da149462f04f199b2c8 (diff)
parent49cd3995862c0bed0701f84535812e1d0690896f (diff)
downloadvcpkg-39b69e5b06df309b9dcfea55296a4c2c3eea93ce.tar.gz
vcpkg-39b69e5b06df309b9dcfea55296a4c2c3eea93ce.zip
Merge pull request #1111 from Microsoft/docs
[vcpkg] Documentation revamp using MkDocs & readthedocs
Diffstat (limited to 'scripts/cmake/vcpkg_find_acquire_program.cmake')
-rw-r--r--scripts/cmake/vcpkg_find_acquire_program.cmake34
1 files changed, 34 insertions, 0 deletions
diff --git a/scripts/cmake/vcpkg_find_acquire_program.cmake b/scripts/cmake/vcpkg_find_acquire_program.cmake
index 127982842..e7e33c692 100644
--- a/scripts/cmake/vcpkg_find_acquire_program.cmake
+++ b/scripts/cmake/vcpkg_find_acquire_program.cmake
@@ -1,3 +1,37 @@
+## # vcpkg_find_acquire_program
+##
+## Download or find a well-known tool.
+##
+## ## Usage
+## ```cmake
+## vcpkg_find_acquire_program(<VAR>)
+## ```
+## ## Parameters
+## ### VAR
+## This variable specifies both the program to be acquired as well as the out parameter that will be set to the path of the program executable.
+##
+## ## Notes
+## The current list of programs includes:
+##
+## - 7Z
+## - BISON
+## - FLEX
+## - PERL
+## - PYTHON2
+## - PYTHON3
+## - JOM
+## - MESON
+## - NASM
+## - NINJA
+## - YASM
+##
+## Note that msys2 has a dedicated helper function: [`vcpkg_acquire_msys`](vcpkg_acquire_msys.md).
+##
+## ## Examples
+##
+## * [ffmpeg](https://github.com/Microsoft/vcpkg/blob/master/ports/ffmpeg/portfile.cmake)
+## * [openssl](https://github.com/Microsoft/vcpkg/blob/master/ports/openssl/portfile.cmake)
+## * [qt5](https://github.com/Microsoft/vcpkg/blob/master/ports/qt5/portfile.cmake)
function(vcpkg_find_acquire_program VAR)
if(${VAR} AND NOT ${VAR} MATCHES "-NOTFOUND")
return()