From 53e3b41ae19893e3a1ba25e7f04b59e8fc53321b Mon Sep 17 00:00:00 2001 From: Billy O'Neal Date: Mon, 20 Sep 2021 09:07:26 -0700 Subject: [docs] Document deprecated functions from #20142 in the maintainer guide. (#20217) * Document deprecated functions from #20142 in the maintainer guide. See discussion at https://github.com/microsoft/vcpkg/pull/20142#issuecomment-921146572 * Reorder list to match natural `portfile.cmake` order, as suggested by @dg0yt --- docs/maintainers/maintainer-guide.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/maintainers/maintainer-guide.md b/docs/maintainers/maintainer-guide.md index 185d3d15b..2bd8f61f5 100644 --- a/docs/maintainers/maintainer-guide.md +++ b/docs/maintainers/maintainer-guide.md @@ -46,6 +46,25 @@ At this time, the following helpers are deprecated: 2. `vcpkg_apply_patches()` should be replaced by the `PATCHES` arguments to the "extract" helpers (e.g. [`vcpkg_from_github()`](vcpkg_from_github.md)) 3. `vcpkg_build_msbuild()` should be replaced by [`vcpkg_install_msbuild()`](vcpkg_install_msbuild.md) 4. `vcpkg_copy_tool_dependencies()` should be replaced by [`vcpkg_copy_tools()`](vcpkg_copy_tools.md) +5. `vcpkg_configure_cmake` should be replaced by [`vcpkg_cmake_configure()`](vcpkg_cmake_configure.md) after removing `PREFER_NINJA` (from port `vcpkg-cmake`) +6. `vcpkg_build_cmake` should be replaced by [`vcpkg_cmake_build()`](vcpkg_cmake_build.md) (from port `vcpkg-cmake`) +7. `vcpkg_install_cmake` should be replaced by [`vcpkg_cmake_install()`](vcpkg_cmake_install.md) (from port `vcpkg-cmake`) +8. `vcpkg_fixup_cmake_targets` should be replaced by [`vcpkg_cmake_config_fixup`](vcpkg_cmake_config_fixup.md) (from port `vcpkg-cmake-config`) + +Some of the replacement helper functions are in "tools ports" to allow consumers to pin their +behavior at specific versions, to allow locking the behavior of the helpers at a particular +version. Tools ports need to be added to your port's `"dependencies"`, like so: + +```json +{ + "name": "vcpkg-cmake", + "host": true +}, +{ + "name": "vcpkg-cmake-config", + "host": true +} +``` ### Avoid excessive comments in portfiles -- cgit v1.2.3