Commit Graph

8 Commits

Author SHA1 Message Date
Robert Schumacher
7d2449c346
[docs] Delete embedded documentation in favor of docs/ (#25096)
* [docs] Delete embedded documentation in favor of docs/

Drive-by for the helper ports:
1. "documentation": "https://vcpkg.io/en/docs/README.html"
2. "license": "MIT"
3. Use `include_guard(GLOBAL)` in all script files
4. Make sure any persistent variables are saved to the cache

* [docs] Restore empty regenerate.ps1 to satisfy Azure Pipelines

* [docs] PR comments
2022-06-07 16:26:51 -07:00
Jack·Boos·Yu
dd7550b0fc
[vcpkg_fail_port_install] Deprecate function (#21489)
* [vcpkg_fail_port_install] Deprecate function

* Update doc

* Apply suggestions

* Revert changes about include this function and delete doc

* Apply suggestions

* version

* Update docs/maintainers/vcpkg_fail_port_install.md

Co-authored-by: autoantwort <41973254+autoantwort@users.noreply.github.com>

* Update scripts/cmake/vcpkg_fail_port_install.cmake

* Update scripts/cmake/vcpkg_fail_port_install.cmake

* Use message("${Z_VCPKG_BACKCOMPAT_MESSAGE_LEVEL}"  to ensure it works with `--prohibit-backcompat-features`.

Co-authored-by: autoantwort <41973254+autoantwort@users.noreply.github.com>
Co-authored-by: Phoebe <20694052+PhoebeHui@users.noreply.github.com>
Co-authored-by: Billy Robert O'Neal III <bion@microsoft.com>
2022-02-03 13:04:55 -08:00
nicole mazzuca
bfbdf28bf4
[vcpkg_fail_port_install] add a warning about extra args when ALWAYS is passed (#20314)
* [vcpkg_fail_port_install] add a warning about extra args when ALWAYS is passed

* Address the review suggestions

Co-authored-by: PhoebeHui <20694052+PhoebeHui@users.noreply.github.com>
2021-12-28 14:43:05 -08:00
nicole mazzuca
0e914ba681
[scripts-audit] Rollup 2021-05-21 (#18112)
* [scripts-audit] vcpkg_acquire_msys (#17687)

* [vcpkg.cmake] Change find_package function -> macro in order to shorten trace (#17997)

switch from function to macro

* [scripts-audit] z_vcpkg_apply_patches (#18013)

* [scripts-audit] z_vcpkg_escape_regex_control_characters (#18013)

* [scripts-audit] vcpkg_fail_port_install (#18054)

Note that this change allows existing failures;
it changes MATCHES to STREQUAL, meaning that
vcpkg_fail_port_install(ON_ARCH "arm") now succeeds on arm64;
this change in behavior is fine (IMO) since it strictly succeeds
when it used to fail.
2021-05-26 13:40:48 -07:00
nicole mazzuca
6b117c9c7e
[vcpkg docs] Check for documentation generation in CI (#14614)
* [vcpkg docs] Change how documenting port functions works

Instead of using `##`, use comment blocks for documentation.

Also, add some minor docs and change RST -> MD
so we actually get docs generated.

* add CI stuff

* regenerate docs

* fix vcpkg_find_acquire_program to not use _execute_process
2020-12-01 13:37:26 -08:00
Joachim Gehweiler
0ff75ac80b
[vcpkg] Fix more cases of semicolon mishandling in "scripts" - follow-up to PR #12926 (#13968) 2020-10-26 19:30:27 -07:00
Robert Schumacher
5deea3b975
[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-12 15:58:43 -08:00
Alexander Neumann
cabbe16525 [vcpkg/cmake] Added a function to fail from portfiles in a default way (#7601)
* added function vcpkg_fail_port_install to fail the portfile under requested circumstances and display a standarized failure message

* added always option.

* fix linux regressions

* bump control for ci tu rerun
2019-08-11 23:24:20 -07:00