aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJacob Zhong <cmpute@qq.com>2018-02-24 16:00:51 +0800
committerRobert Schumacher <roschuma@microsoft.com>2018-02-24 00:00:51 -0800
commit63901137f66ec90f4a51070bd53a2d7433b4b54a (patch)
treee52b6c07eaa92c1ad2d21b7f62da9595a78f02e1 /docs
parentc55ccbf146f6aeaba158f58614578906ae3f01ab (diff)
downloadvcpkg-63901137f66ec90f4a51070bd53a2d7433b4b54a.tar.gz
vcpkg-63901137f66ec90f4a51070bd53a2d7433b4b54a.zip
Add doxygen and add packages option to vcpkg_require_msys (#2869)
* Add doxygen to acquired programs * Add packages option to msys function * Add documentation for PACKAGES in vcpkg_require_msys * [ffmpeg][x264] Update to use `PACKAGES` parameter. Tweak docs.
Diffstat (limited to 'docs')
-rw-r--r--docs/maintainers/vcpkg_acquire_msys.md20
1 files changed, 6 insertions, 14 deletions
diff --git a/docs/maintainers/vcpkg_acquire_msys.md b/docs/maintainers/vcpkg_acquire_msys.md
index 53aa6532e..4dc8f5391 100644
--- a/docs/maintainers/vcpkg_acquire_msys.md
+++ b/docs/maintainers/vcpkg_acquire_msys.md
@@ -4,13 +4,18 @@ Download and prepare an MSYS2 instance.
## Usage
```cmake
-vcpkg_acquire_msys(<MSYS_ROOT_VAR>)
+vcpkg_acquire_msys(<MSYS_ROOT_VAR> [PACKAGES <package>...])
```
## Parameters
### MSYS_ROOT_VAR
An out-variable that will be set to the path to MSYS2.
+### PACKAGES
+A list of packages to acquire in msys.
+
+To ensure a package is available: `vcpkg_acquire_msys(MSYS_ROOT PACKAGES make automake1.15)`
+
## Notes
A call to `vcpkg_acquire_msys` will usually be followed by a call to `bash.exe`:
```cmake
@@ -23,19 +28,6 @@ vcpkg_execute_required_process(
LOGNAME build-${TARGET_TRIPLET}-rel
)
```
-To ensure a package is available:
-```cmake
-vcpkg_acquire_msys(MSYS_ROOT)
-set(BASH ${MSYS_ROOT}/usr/bin/bash.exe)
-
-message(STATUS "Installing MSYS Packages")
-vcpkg_execute_required_process(
- COMMAND
- ${BASH} --noprofile --norc -c
- 'PATH=/usr/bin:\$PATH pacman -Sy --noconfirm --needed make'
- WORKING_DIRECTORY ${MSYS_ROOT}
- LOGNAME pacman-${TARGET_TRIPLET})
-```
## Examples