mirror/vcpkg
1
0
Fork 0
mirror of https://github.com/microsoft/vcpkg.git synced 2024-12-11 15:29:02 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
0ab1a9e1c6
vcpkg/docs/maintainers/portfile-functions.md

43 lines
2.2 KiB
Markdown
Raw Normal View History

[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs.
2017-05-25 14:33:16 +08:00
<!-- Run regenerate.ps1 to extract documentation from scripts\cmake\*.cmake -->
# Portfile helper functions
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
- [execute\_process](execute_process.md)
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs.
2017-05-25 14:33:16 +08:00
- [vcpkg\_acquire\_msys](vcpkg_acquire_msys.md)
xalan-c: Install headers correctly (#4565) * Add SKIP_CLEAN option to vcpkg_install_msbuild Also add vcpkg_clean_msbuild function to factor out clean logic and allow re-use in portfiles. * xalan-c: Correct header globbing * vcpkg_install_msbuild: SKIP_CLEAN documentation correction * [xalan-c] Add explicit check for localmsgindex header. [docs] Regenerate
2018-10-26 03:34:45 +08:00
- [vcpkg\_add\_to\_path](vcpkg_add_to_path.md)
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs.
2017-05-25 14:33:16 +08:00
- [vcpkg\_apply\_patches](vcpkg_apply_patches.md)
[vcpkg_build_cmake] Refactor _build_ and _install_ into a single cmake script. Regenerate documentation. Remove MSVC_64_TOOLSET option because it's obsolete.
2017-10-06 08:49:28 +08:00
- [vcpkg\_build\_cmake](vcpkg_build_cmake.md)
[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\_build\_make](vcpkg_build_make.md)
- [vcpkg\_build\_msbuild](vcpkg_build_msbuild.md)
Add function vcpkg_configure_make/vcpkg_build_make/vcpkg_install_make/vcpkg_build_nmake/vcpkg_install_nmake (#8267) * Add function vcpkg_configure_make/vcpkg_build_make. * Fix autoreconf command and add log. * Add vcpkg_install_make. * Fix call function name. * support non-debug mode. * Add nmake support. * [tcl]Add new port for testing. * [vcpkg_configure_make]Fix prefix in linux. * restart CI systen. * Separate vcpkg_build_nmake/vcpkg_install_nmake. Add arg PROJECT_NAME. * fix copy source file. add samples. * Remove uncommon options. Add force install para to autoreconf. * fix build error. * fix options judgment. * enable nmake in windows. * fix some envs and macros. Disable NMAKE in vcpkg_configure_make currently. * update docs. * fix environments. * Modify libosip2 to use vcpkg_configure_make/vcpkg_install_make. * [tcl]Tcl separates PR. * trigger PR-EAGER. * [freexl]Fix options name and remove option NMAKE. * use tool-chain instead of set environments manually. * fix autoreconf para. * use vcpkg_execute_build_process instead.
2019-10-05 22:51:07 +08:00
- [vcpkg\_build\_nmake](vcpkg_build_nmake.md)
[vcpkg] Add vcpkg_check_features (#6958) * [vcpkg] Add vcpkg_check_feature, vcpkg_check_features * [vcpkg] Remove vcpkg_check_feature * [oniguruma,xtensor] Use vcpkg_check_features
2019-06-29 01:17:39 +08:00
- [vcpkg\_check\_features](vcpkg_check_features.md)
New packages: libimobiledevice, getopt, readline (#3504) * Add libplist * Add libusbmuxd * Fix typos * Add getopt * Add libimobiledevice * Fix typos * Add libideviceactivation * Add ideviceinstaller * Include utilities * Install usbmuxd * Add readline * Fix readline on 64-bit windows * Add libirecovery * libideviceactivation: include tools * Bump versions to fix build issues * Bump versions * Add idevicerestore * [getopt][getopt-win32] Rename to getopt-win32 and only install on Windows Desktop * [readline][readline-win32] Rename to readline-win32 and only install for Windows Desktop * [vcpkg_from_github][vcpkg_apply_patches] Make PATCHES relative to the current port directory * [vcpkg_install_msbuild][vcpkg_check_linkage] Introduce vcpkg_install_msbuild() and vcpkg_check_linkage(). * [libimobiledevice et al] Use vcpkg_from_github() and vcpkg_install_msbuild() * [readline] Fix static builds
2018-08-08 19:15:13 +08:00
- [vcpkg\_check\_linkage](vcpkg_check_linkage.md)
[vcpkg] Add new function vcpkg_copy_tools (#8749) * [vcpkg] Add new function vcpkg_copy_tools * [cpuinfo][czmq][nanomsg][uriparser] Use vcpkg_copy_tools * [czmq] Clean even tools are not copied [libsvm][zyre] Use vcpkg_copy_tools * [vcpkg-copy-tools] Clean debug/bin This should fix czmq build error * [czmq] czmq does not have BUILD_TOOLS option * [vcpkg] Split clean logic into another function * [cpuinfo][czmq][nanomsg][uriparser] Fix calling of vcpkg_copy_tools * [zyre] Fix regression error * [vcpkg] Update try_remove_empty_directory * [libsvm] Fix vcpkg_copy_tools call
2020-05-02 06:28:55 +08:00
- [vcpkg\_clean\_executables\_in\_bin](vcpkg_clean_executables_in_bin.md)
xalan-c: Install headers correctly (#4565) * Add SKIP_CLEAN option to vcpkg_install_msbuild Also add vcpkg_clean_msbuild function to factor out clean logic and allow re-use in portfiles. * xalan-c: Correct header globbing * vcpkg_install_msbuild: SKIP_CLEAN documentation correction * [xalan-c] Add explicit check for localmsgindex header. [docs] Regenerate
2018-10-26 03:34:45 +08:00
- [vcpkg\_clean\_msbuild](vcpkg_clean_msbuild.md)
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](vcpkg_common_definitions.md)
[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\_configure\_cmake](vcpkg_configure_cmake.md)
Add function vcpkg_configure_make/vcpkg_build_make/vcpkg_install_make/vcpkg_build_nmake/vcpkg_install_nmake (#8267) * Add function vcpkg_configure_make/vcpkg_build_make. * Fix autoreconf command and add log. * Add vcpkg_install_make. * Fix call function name. * support non-debug mode. * Add nmake support. * [tcl]Add new port for testing. * [vcpkg_configure_make]Fix prefix in linux. * restart CI systen. * Separate vcpkg_build_nmake/vcpkg_install_nmake. Add arg PROJECT_NAME. * fix copy source file. add samples. * Remove uncommon options. Add force install para to autoreconf. * fix build error. * fix options judgment. * enable nmake in windows. * fix some envs and macros. Disable NMAKE in vcpkg_configure_make currently. * update docs. * fix environments. * Modify libosip2 to use vcpkg_configure_make/vcpkg_install_make. * [tcl]Tcl separates PR. * trigger PR-EAGER. * [freexl]Fix options name and remove option NMAKE. * use tool-chain instead of set environments manually. * fix autoreconf para. * use vcpkg_execute_build_process instead.
2019-10-05 22:51:07 +08:00
- [vcpkg\_configure\_make](vcpkg_configure_make.md)
[vcpkg-docs] Add documentation for `vcpkg_configure_meson()`, `vcpkg_install_meson()`, `vcpkg_fixup_cmake_targts()`, and `vcpkg_prettify_command()` (#7606) * [vcpkg-docs] Add documentation for `vcpkg_configure_meson()`, `vcpkg_install_meson()`, `vcpkg_fixup_cmake_targts()`, and `vcpkg_prettify_command()` * [docs] Address code review comments. Reformat docs for vcpkg_fail_port_install.
2020-02-13 07:58:43 +08:00
- [vcpkg\_configure\_meson](vcpkg_configure_meson.md)
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs.
2017-05-25 14:33:16 +08:00
- [vcpkg\_copy\_pdbs](vcpkg_copy_pdbs.md)
[vcpkg] Add new function vcpkg_copy_tools (#8749) * [vcpkg] Add new function vcpkg_copy_tools * [cpuinfo][czmq][nanomsg][uriparser] Use vcpkg_copy_tools * [czmq] Clean even tools are not copied [libsvm][zyre] Use vcpkg_copy_tools * [vcpkg-copy-tools] Clean debug/bin This should fix czmq build error * [czmq] czmq does not have BUILD_TOOLS option * [vcpkg] Split clean logic into another function * [cpuinfo][czmq][nanomsg][uriparser] Fix calling of vcpkg_copy_tools * [zyre] Fix regression error * [vcpkg] Update try_remove_empty_directory * [libsvm] Fix vcpkg_copy_tools call
2020-05-02 06:28:55 +08:00
- [vcpkg\_copy\_tools](vcpkg_copy_tools.md)
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs.
2017-05-25 14:33:16 +08:00
- [vcpkg\_copy\_tool\_dependencies](vcpkg_copy_tool_dependencies.md)
- [vcpkg\_download\_distfile](vcpkg_download_distfile.md)
[docs]Update cmake docs (#7039)
2019-06-26 07:08:18 +08:00
- [vcpkg\_execute\_build\_process](vcpkg_execute_build_process.md)
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs.
2017-05-25 14:33:16 +08:00
- [vcpkg\_execute\_required\_process](vcpkg_execute_required_process.md)
- [vcpkg\_extract\_source\_archive](vcpkg_extract_source_archive.md)
[vcpkg_extract_source_archive_ex] Document vcpkg_extract_source_archive_ex
2018-11-23 06:48:18 +08:00
- [vcpkg\_extract\_source\_archive\_ex](vcpkg_extract_source_archive_ex.md)
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\_fail\_port\_install](vcpkg_fail_port_install.md)
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs.
2017-05-25 14:33:16 +08:00
- [vcpkg\_find\_acquire\_program](vcpkg_find_acquire_program.md)
[vcpkg-docs] Add documentation for `vcpkg_configure_meson()`, `vcpkg_install_meson()`, `vcpkg_fixup_cmake_targts()`, and `vcpkg_prettify_command()` (#7606) * [vcpkg-docs] Add documentation for `vcpkg_configure_meson()`, `vcpkg_install_meson()`, `vcpkg_fixup_cmake_targts()`, and `vcpkg_prettify_command()` * [docs] Address code review comments. Reformat docs for vcpkg_fail_port_install.
2020-02-13 07:58:43 +08:00
- [vcpkg\_fixup\_cmake\_targets](vcpkg_fixup_cmake_targets.md)
[vcpkg_build_cmake] Refactor _build_ and _install_ into a single cmake script. Regenerate documentation. Remove MSVC_64_TOOLSET option because it's obsolete.
2017-10-06 08:49:28 +08:00
- [vcpkg\_from\_bitbucket](vcpkg_from_bitbucket.md)
[docs] Regenerate docs for vcpkg_from_git
2018-11-07 07:47:02 +08:00
- [vcpkg\_from\_git](vcpkg_from_git.md)
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs.
2017-05-25 14:33:16 +08:00
- [vcpkg\_from\_github](vcpkg_from_github.md)
[docs] Add docs for vcpkg_from_gitlab()
2018-08-08 19:16:15 +08:00
- [vcpkg\_from\_gitlab](vcpkg_from_gitlab.md)
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs.
2017-05-25 14:33:16 +08:00
- [vcpkg\_install\_cmake](vcpkg_install_cmake.md)
[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\_install\_make](vcpkg_install_make.md)
[vcpkg-docs] Add documentation for `vcpkg_configure_meson()`, `vcpkg_install_meson()`, `vcpkg_fixup_cmake_targts()`, and `vcpkg_prettify_command()` (#7606) * [vcpkg-docs] Add documentation for `vcpkg_configure_meson()`, `vcpkg_install_meson()`, `vcpkg_fixup_cmake_targts()`, and `vcpkg_prettify_command()` * [docs] Address code review comments. Reformat docs for vcpkg_fail_port_install.
2020-02-13 07:58:43 +08:00
- [vcpkg\_install\_meson](vcpkg_install_meson.md)
[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\_install\_msbuild](vcpkg_install_msbuild.md)
Add function vcpkg_configure_make/vcpkg_build_make/vcpkg_install_make/vcpkg_build_nmake/vcpkg_install_nmake (#8267) * Add function vcpkg_configure_make/vcpkg_build_make. * Fix autoreconf command and add log. * Add vcpkg_install_make. * Fix call function name. * support non-debug mode. * Add nmake support. * [tcl]Add new port for testing. * [vcpkg_configure_make]Fix prefix in linux. * restart CI systen. * Separate vcpkg_build_nmake/vcpkg_install_nmake. Add arg PROJECT_NAME. * fix copy source file. add samples. * Remove uncommon options. Add force install para to autoreconf. * fix build error. * fix options judgment. * enable nmake in windows. * fix some envs and macros. Disable NMAKE in vcpkg_configure_make currently. * update docs. * fix environments. * Modify libosip2 to use vcpkg_configure_make/vcpkg_install_make. * [tcl]Tcl separates PR. * trigger PR-EAGER. * [freexl]Fix options name and remove option NMAKE. * use tool-chain instead of set environments manually. * fix autoreconf para. * use vcpkg_execute_build_process instead.
2019-10-05 22:51:07 +08:00
- [vcpkg\_install\_nmake](vcpkg_install_nmake.md)
[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\_install\_qmake](vcpkg_install_qmake.md)
[vcpkg_check_features] Set output variable explicitly and allow reverse-logic check (#7558) * [vcpkg_check_features] Set OUT_EXPAND_OPTIONS explicitly * [vcpkg_check_features] Allow reverse logic for features * [vcpkg_check_features] Document new parameters * [vcpkg_check_features] Remove unnecessary logging * Do not create variables for each feature only set OUT_FEATURE_OPTIONS * Improve documentation * Update ports that use vcpkg_check_features() * Missing documentation updates * [pcl] Fix tools feature * [opencv,opencv4] Fix usage of vcpkg_check_features() * [opencv4] Fix typo
2019-08-14 11:13:55 +08:00
- [vcpkg\_prettify\_command](vcpkg_prettify_command.md)
xalan-c: Install headers correctly (#4565) * Add SKIP_CLEAN option to vcpkg_install_msbuild Also add vcpkg_clean_msbuild function to factor out clean logic and allow re-use in portfiles. * xalan-c: Correct header globbing * vcpkg_install_msbuild: SKIP_CLEAN documentation correction * [xalan-c] Add explicit check for localmsgindex header. [docs] Regenerate
2018-10-26 03:34:45 +08:00
- [vcpkg\_test\_cmake](vcpkg_test_cmake.md)
Reference in New Issue Copy Permalink