mirror/vcpkg
1
0
Fork 0
mirror of https://github.com/microsoft/vcpkg.git synced 2024-12-18 22:07:50 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
4e368f6390
vcpkg/docs/maintainers/vcpkg_common_definitions.md

39 lines
3.3 KiB
Markdown
Raw Normal View History

Download Mode (#7950) * [portfile functions] Override execute_process() to accept ALLOW_IN_DOWNLOAD_MODE option * [vcpkg install] Set VCPKG_DOWNLOAD_MODE when using --only-downloads option * [vcpkg_find_acquire_program] Allow in Download Mode * Don't stop when build fails for a package * Download sources for all packages in dependency graph * Improve output messages * Enable acquiring MSYS packages in download mode * Documentation * Update documentation * execute_process() always fails on Download Mode * Regenerate docs and fix formatting * Run clang-format * Use _execute_process on vcpkg_from_<source> helpers * Fix calls to _execute_process() when not in Download Mode
2019-08-29 04:49:29 +08:00
# vcpkg_common_definitions
[docs] Fix the automatically generated document URL (#16611) * [document] Fix the automatically generated document URL * [docs] Format all documents
2021-03-11 01:56:07 +08:00
The latest version of this document lives in the [vcpkg repo](https://github.com/Microsoft/vcpkg/blob/master/docs/maintainers/vcpkg_common_definitions.md).
[scripts-audit] Rollup PR 2021-02-26 (#16440) * [scripts-audit rollup] PR #16419 * pull the cmake doc comment parsing out into its own function * support cmake helper ports * add real support for deprecation, as opposed to ad-hoc * [scripts-audit rollup] PR #16192 * add a z_ in front of internal functions * move internal functions out set feature_vars again in parent scope * [scripts-audit rollup] PR #16309 Audit vcpkg_copy_pdbs * [scripts-audit rollup] PR #16304 * Fix usage, documentation * [scripts-audit rollup] PR #16393 * [scripts-audit rollup] PR #16377 Deprecate `vcpkg_*_cmake` in favor of `vcpkg_cmake_*` from the `vcpkg-cmake` port, as well as `vcpkg_fixup_cmake_targets` in favor of `vcpkg_cmake_config_fixup` from the `vcpkg-cmake-config` port.
2021-03-01 05:17:19 +08:00
[aws-cpp-sdk] [zlib] [openssl] [curl] Fix zlib, OpenSSL, curl and AWS SDK for Android (#15725) * Fix Android build * Add versioning support * Disable building tests for cURL * Fix patch file * Fix patch file * Fix patch file * Fix versioning * Fix patch file * [aws-sdk-cpp] Update patch * update baseline * Fix dependencies * Simplify Android configuration * Simplify Android configuration * Simplify Android configuration Add alternative Git CMake script * Bump port version * Bump version files * Remove redundant file * Bump port version * Fix version files * Do not build curl, zlib and OpenSSL * Typo de pkgconfig script * Fix cURL build for Android * Add required flags * Revert macro change * Fix curl build for other platforms * Fix curl build for other platforms * [vcpkg baseline][gsoap] Update to 2.8.111 * Update versions * [ktx/otl] Update download hash * update version record * Fix curl build for other platforms * Update ports/aws-sdk-cpp/portfile.cmake Co-authored-by: Jack·Boos·Yu <47264268+JackBoosY@users.noreply.github.com> * Update ports/aws-sdk-cpp/portfile.cmake Co-authored-by: Jack·Boos·Yu <47264268+JackBoosY@users.noreply.github.com> * Remove FingGit * Fix configuration step * Bump cURL port version * Bump cURL port version * Bump AWS SDK C++ version * Bump AWS SDK C++ version * Bump AWS SDK C++ version * Bump AWS SDK C++ version * Update ports/curl/CONTROL * Update ports/curl/portfile.cmake * update baseline record * Fix Git * update version record * Typo * Fix cross-platform builds of OpenSSL on MinGW/Windows * Update version * Fix version * update doc * Update ports/aws-sdk-cpp/portfile.cmake Co-authored-by: Robert Schumacher <roschuma@microsoft.com> * Update ports/aws-sdk-cpp/portfile.cmake Co-authored-by: Robert Schumacher <roschuma@microsoft.com> * Add debug libraries to curl for Android Simplify OpenSSL patch for curl Update OpenSSL's port version * Update aws-sdk-cpp, curl, and OpenSSL versions * Fix libssh after latest update * Update libssh version * Update libssh version * Update ports/libssh/portfile.cmake Co-authored-by: nicole mazzuca <mazzucan@outlook.com> * Update ports/curl/portfile.cmake Co-authored-by: nicole mazzuca <mazzucan@outlook.com> * Update ports/libssh/portfile.cmake * Apply suggestions from code review * Use correct variables for OpenSSL libraries when building curl for Android Fix zlib building for Android Remove redundant patch comments * Bump zlib's port version * Update zlib, libssh, and curl versions * [vcpkg baseline][popsift] Fix vcpkg_find_cuda.cmake path * update version record * Update versions/o-/openssl.json Co-authored-by: Jack·Boos·Yu <47264268+JackBoosY@users.noreply.github.com> Co-authored-by: Ahmed Yarub Hani Al Nuaimi <ahmed.alnuaimi@zwift.com> Co-authored-by: JackBoosY <yuzaiyang@beyondsoft.com> Co-authored-by: Nicole Mazzuca <mazzucan@outlook.com> Co-authored-by: NancyLi1013 <lirui09@beyondsoft.com> Co-authored-by: Jack·Boos·Yu <47264268+JackBoosY@users.noreply.github.com> Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2021-04-20 08:08:51 +08:00
This file defines the following variables which are commonly needed or used in portfiles:
Download Mode (#7950) * [portfile functions] Override execute_process() to accept ALLOW_IN_DOWNLOAD_MODE option * [vcpkg install] Set VCPKG_DOWNLOAD_MODE when using --only-downloads option * [vcpkg_find_acquire_program] Allow in Download Mode * Don't stop when build fails for a package * Download sources for all packages in dependency graph * Improve output messages * Enable acquiring MSYS packages in download mode * Documentation * Update documentation * execute_process() always fails on Download Mode * Regenerate docs and fix formatting * Run clang-format * Use _execute_process on vcpkg_from_<source> helpers * Fix calls to _execute_process() when not in Download Mode
2019-08-29 04:49:29 +08:00
```cmake
[docs] Document `VERSION` (#27178) * [docs] Document * Update docs/maintainers/vcpkg_common_definitions.md Co-authored-by: Victor Romero <romerosanchezv@gmail.com> Co-authored-by: Billy O'Neal <bion@microsoft.com> Co-authored-by: Victor Romero <romerosanchezv@gmail.com>
2022-10-14 11:19:01 +08:00
PORT The name of the port that is currently being built
VERSION The version of the port that is currently being built
Add VCPKG_TARGET_IS_EMSCRIPTEN, fix opus and libsodium ports for wasm32-emscripten (#26318) * vcpkg_common_definitions: Add VCPKG_TARGET_IS_EMSCRIPTEN * [opus] Fix wasm32-emscripten builds * [libsodium] Fix wasm32-emscripten builds * Run x-add-version
2022-09-09 05:01:20 +08:00
VCPKG_TARGET_IS_<target> with <target> being one of the following: WINDOWS, UWP, MINGW, LINUX, OSX, ANDROID, FREEBSD, OPENBSD, EMSCRIPTEN. only defined if <target>
Document VCPKG_TARGET_IS_MINGW (#19790)
2021-08-31 01:18:49 +08:00
VCPKG_HOST_IS_<host> with <host> being one of the following: WINDOWS, LINUX, OSX, FREEBSD, OPENBSD. only defined if <host>
[vcpkg_install_qmake] Add vcpkg_install_qmake (#9412) * [vcpkg_install_qmake] Add vcpkg_install_qmake and convert existing ports to use it. [vcpkg_configure_qmake] Add 'staticlib' to CONFIG in static builds * [vcpkg_configure_qmake] Don't specify DESTDIR * [libqglviewer][vcpkg_configure_qmake] Add staticlib CONFIG only for libqglviewer * [qt5-base] Increment version to track changes in vcpkg_configure_qmake()
2019-12-23 22:10:12 +08:00
VCPKG_HOST_PATH_SEPARATOR Host specific path separator (USAGE: "<something>${VCPKG_HOST_PATH_SEPARATOR}<something>"; only use and pass variables with VCPKG_HOST_PATH_SEPARATOR within "")
VCPKG_HOST_EXECUTABLE_SUFFIX executable suffix of the host
VCPKG_TARGET_EXECUTABLE_SUFFIX executable suffix of the target
[vcpkg_copy_tools] support copying .app bundles (#20210) * [vcpkg_copy_tools] support copying .app bundles * check for VCPKG_TARGET_IS_OSX * Fix formatting * [vcpkg_copy_tools] copy bundle and plain bin if both present * Update scripts/cmake/vcpkg_copy_tools.cmake Co-authored-by: Billy Robert O'Neal III <bion@microsoft.com> Co-authored-by: nicole mazzuca <83086508+strega-nil-ms@users.noreply.github.com>
2021-10-05 03:40:14 +08:00
VCPKG_HOST_BUNDLE_SUFFIX bundle suffix of the host
VCPKG_TARGET_BUNDLE_SUFFIX bundle suffix of the target
Download Mode (#7950) * [portfile functions] Override execute_process() to accept ALLOW_IN_DOWNLOAD_MODE option * [vcpkg install] Set VCPKG_DOWNLOAD_MODE when using --only-downloads option * [vcpkg_find_acquire_program] Allow in Download Mode * Don't stop when build fails for a package * Download sources for all packages in dependency graph * Improve output messages * Enable acquiring MSYS packages in download mode * Documentation * Update documentation * execute_process() always fails on Download Mode * Regenerate docs and fix formatting * Run clang-format * Use _execute_process on vcpkg_from_<source> helpers * Fix calls to _execute_process() when not in Download Mode
2019-08-29 04:49:29 +08:00
VCPKG_TARGET_STATIC_LIBRARY_PREFIX static library prefix for target (same as CMAKE_STATIC_LIBRARY_PREFIX)
VCPKG_TARGET_STATIC_LIBRARY_SUFFIX static library suffix for target (same as CMAKE_STATIC_LIBRARY_SUFFIX)
VCPKG_TARGET_SHARED_LIBRARY_PREFIX shared library prefix for target (same as CMAKE_SHARED_LIBRARY_PREFIX)
VCPKG_TARGET_SHARED_LIBRARY_SUFFIX shared library suffix for target (same as CMAKE_SHARED_LIBRARY_SUFFIX)
[vcpkg_install_qmake] Add vcpkg_install_qmake (#9412) * [vcpkg_install_qmake] Add vcpkg_install_qmake and convert existing ports to use it. [vcpkg_configure_qmake] Add 'staticlib' to CONFIG in static builds * [vcpkg_configure_qmake] Don't specify DESTDIR * [libqglviewer][vcpkg_configure_qmake] Add staticlib CONFIG only for libqglviewer * [qt5-base] Increment version to track changes in vcpkg_configure_qmake()
2019-12-23 22:10:12 +08:00
VCPKG_TARGET_IMPORT_LIBRARY_PREFIX import library prefix for target (same as CMAKE_IMPORT_LIBRARY_PREFIX)
VCPKG_TARGET_IMPORT_LIBRARY_SUFFIX import library suffix for target (same as CMAKE_IMPORT_LIBRARY_SUFFIX)
VCPKG_FIND_LIBRARY_PREFIXES target dependent prefixes used for find_library calls in portfiles
VCPKG_FIND_LIBRARY_SUFFIXES target dependent suffixes used for find_library calls in portfiles
[vcpkg] Track hashes of cmake script helpers in consuming portfiles (#12254) * [vcpkg] Track hashes of cmake script helpers in consuming portfiles * [vcpkg] Format * [vcpkg_find_acquire_program] Use cpkg_from_sourceforge for FLEX and BISON Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2020-07-14 04:43:39 +08:00
VCPKG_SYSTEM_LIBRARIES list of libraries are provide by the toolchain and are not managed by vcpkg
[host dependencies] add support in the scripts (#16627) This contains all the docs and scripts changes from #16479, without any of the ports changes, for easier CR
2021-03-11 07:33:16 +08:00
TARGET_TRIPLET the name of the current triplet to build for
CURRENT_INSTALLED_DIR the absolute path to the installed files for the current triplet
HOST_TRIPLET the name of the triplet corresponding to the host
CURRENT_HOST_INSTALLED_DIR the absolute path to the installed files for the host triplet
[vcpkg/scripts] add variable VCPKG_CROSSCOMPILING (#16900) * add VCPKG_CROSSCOMPILING * update docs * Apply suggestions from code review Co-authored-by: nicole mazzuca <mazzucan@outlook.com> * update docs Co-authored-by: nicole mazzuca <mazzucan@outlook.com>
2021-04-03 03:51:05 +08:00
VCPKG_CROSSCOMPILING Whether vcpkg is cross-compiling: in other words, whether TARGET_TRIPLET and HOST_TRIPLET are different
Download Mode (#7950) * [portfile functions] Override execute_process() to accept ALLOW_IN_DOWNLOAD_MODE option * [vcpkg install] Set VCPKG_DOWNLOAD_MODE when using --only-downloads option * [vcpkg_find_acquire_program] Allow in Download Mode * Don't stop when build fails for a package * Download sources for all packages in dependency graph * Improve output messages * Enable acquiring MSYS packages in download mode * Documentation * Update documentation * execute_process() always fails on Download Mode * Regenerate docs and fix formatting * Run clang-format * Use _execute_process on vcpkg_from_<source> helpers * Fix calls to _execute_process() when not in Download Mode
2019-08-29 04:49:29 +08:00
```
[vcpkg_install_qmake] Add vcpkg_install_qmake (#9412) * [vcpkg_install_qmake] Add vcpkg_install_qmake and convert existing ports to use it. [vcpkg_configure_qmake] Add 'staticlib' to CONFIG in static builds * [vcpkg_configure_qmake] Don't specify DESTDIR * [libqglviewer][vcpkg_configure_qmake] Add staticlib CONFIG only for libqglviewer * [qt5-base] Increment version to track changes in vcpkg_configure_qmake()
2019-12-23 22:10:12 +08:00
CMAKE_STATIC_LIBRARY_(PREFIX|SUFFIX), CMAKE_SHARED_LIBRARY_(PREFIX|SUFFIX) and CMAKE_IMPORT_LIBRARY_(PREFIX|SUFFIX) are defined for the target
Furthermore the variables CMAKE_FIND_LIBRARY_(PREFIXES|SUFFIXES) are also defined for the target so that
portfiles are able to use find_library calls to discover dependent libraries within the current triplet for ports.
Download Mode (#7950) * [portfile functions] Override execute_process() to accept ALLOW_IN_DOWNLOAD_MODE option * [vcpkg install] Set VCPKG_DOWNLOAD_MODE when using --only-downloads option * [vcpkg_find_acquire_program] Allow in Download Mode * Don't stop when build fails for a package * Download sources for all packages in dependency graph * Improve output messages * Enable acquiring MSYS packages in download mode * Documentation * Update documentation * execute_process() always fails on Download Mode * Regenerate docs and fix formatting * Run clang-format * Use _execute_process on vcpkg_from_<source> helpers * Fix calls to _execute_process() when not in Download Mode
2019-08-29 04:49:29 +08:00
## Source
[scripts-audit] Rollup PR 2021-02-26 (#16440) * [scripts-audit rollup] PR #16419 * pull the cmake doc comment parsing out into its own function * support cmake helper ports * add real support for deprecation, as opposed to ad-hoc * [scripts-audit rollup] PR #16192 * add a z_ in front of internal functions * move internal functions out set feature_vars again in parent scope * [scripts-audit rollup] PR #16309 Audit vcpkg_copy_pdbs * [scripts-audit rollup] PR #16304 * Fix usage, documentation * [scripts-audit rollup] PR #16393 * [scripts-audit rollup] PR #16377 Deprecate `vcpkg_*_cmake` in favor of `vcpkg_cmake_*` from the `vcpkg-cmake` port, as well as `vcpkg_fixup_cmake_targets` in favor of `vcpkg_cmake_config_fixup` from the `vcpkg-cmake-config` port.
2021-03-01 05:17:19 +08:00
[scripts/cmake/vcpkg\_common\_definitions.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_common_definitions.cmake)
Reference in New Issue Copy Permalink