mirror/vcpkg
1
0
Fork 0
mirror of https://github.com/microsoft/vcpkg.git synced 2024-11-28 18:19:07 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

[docs] Document deprecated functions from #20142 in the maintainer guide. (#20217)

Browse Source 
* 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
This commit is contained in:
Billy O'Neal 2021-09-20 09:07:26 -07:00 committed by GitHub
parent 28f361cfa9
commit 53e3b41ae1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/maintainers/maintainer-guide.md
View File

@ -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