diff options
| author | autoantwort <41973254+autoantwort@users.noreply.github.com> | 2021-05-09 19:47:21 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-05-09 10:47:21 -0700 |
| commit | f44d4c169f1b81a6188b330dbd837881ffb9ef2b (patch) | |
| tree | c976ce113fc24c1cbfc9feb6a7d8fab9a0844ee2 /docs/maintainers | |
| parent | cf2ea00e821b6cb197a3a3f9f5524ea05ed61e4a (diff) | |
| download | vcpkg-f44d4c169f1b81a6188b330dbd837881ffb9ef2b.tar.gz vcpkg-f44d4c169f1b81a6188b330dbd837881ffb9ef2b.zip | |
[docs] link to new functions in deprecated warnings (#17179)
* [docs] link to new functions in deprecated warnings
* [docs] add deprecation messages to portfile-functions.md
* [docs] also update documentation in .cmake files
* [docs] introduce new directive DEPRECATED BY in the documentation generation script and use that directive
* Trigger Build
* Trigger Build
* Trigger Build
Diffstat (limited to 'docs/maintainers')
| -rw-r--r-- | docs/maintainers/portfile-functions.md | 8 | ||||
| -rw-r--r-- | docs/maintainers/vcpkg_apply_patches.md | 2 | ||||
| -rw-r--r-- | docs/maintainers/vcpkg_build_cmake.md | 4 | ||||
| -rw-r--r-- | docs/maintainers/vcpkg_configure_cmake.md | 4 | ||||
| -rw-r--r-- | docs/maintainers/vcpkg_fixup_cmake_targets.md | 4 | ||||
| -rw-r--r-- | docs/maintainers/vcpkg_install_cmake.md | 4 |
6 files changed, 13 insertions, 13 deletions
diff --git a/docs/maintainers/portfile-functions.md b/docs/maintainers/portfile-functions.md index 842ef6137..ccc06db88 100644 --- a/docs/maintainers/portfile-functions.md +++ b/docs/maintainers/portfile-functions.md @@ -5,7 +5,7 @@ - [vcpkg\_acquire\_msys](vcpkg_acquire_msys.md) - [vcpkg\_add\_to\_path](vcpkg_add_to_path.md) - [vcpkg\_apply\_patches](vcpkg_apply_patches.md) (deprecated) -- [vcpkg\_build\_cmake](vcpkg_build_cmake.md) +- [vcpkg\_build\_cmake](vcpkg_build_cmake.md) (deprecated, use [vcpkg\_cmake\_build](ports/vcpkg-cmake/vcpkg_cmake_build.md)) - [vcpkg\_build\_gn](vcpkg_build_gn.md) - [vcpkg\_build\_make](vcpkg_build_make.md) - [vcpkg\_build\_msbuild](vcpkg_build_msbuild.md) @@ -18,7 +18,7 @@ - [vcpkg\_clean\_executables\_in\_bin](vcpkg_clean_executables_in_bin.md) - [vcpkg\_clean\_msbuild](vcpkg_clean_msbuild.md) - [vcpkg\_common\_definitions](vcpkg_common_definitions.md) -- [vcpkg\_configure\_cmake](vcpkg_configure_cmake.md) +- [vcpkg\_configure\_cmake](vcpkg_configure_cmake.md) (deprecated, use [vcpkg\_cmake\_configure](ports/vcpkg-cmake/vcpkg_cmake_configure.md)) - [vcpkg\_configure\_gn](vcpkg_configure_gn.md) - [vcpkg\_configure\_make](vcpkg_configure_make.md) - [vcpkg\_configure\_meson](vcpkg_configure_meson.md) @@ -36,7 +36,7 @@ - [vcpkg\_fail\_port\_install](vcpkg_fail_port_install.md) - [vcpkg\_find\_acquire\_program](vcpkg_find_acquire_program.md) - [vcpkg\_find\_fortran](vcpkg_find_fortran.md) -- [vcpkg\_fixup\_cmake\_targets](vcpkg_fixup_cmake_targets.md) +- [vcpkg\_fixup\_cmake\_targets](vcpkg_fixup_cmake_targets.md) (deprecated, use [vcpkg\_cmake\_config\_fixup](ports/vcpkg-cmake-config/vcpkg_cmake_config_fixup.md)) - [vcpkg\_fixup\_pkgconfig](vcpkg_fixup_pkgconfig.md) - [vcpkg\_from\_bitbucket](vcpkg_from_bitbucket.md) - [vcpkg\_from\_git](vcpkg_from_git.md) @@ -45,7 +45,7 @@ - [vcpkg\_from\_sourceforge](vcpkg_from_sourceforge.md) - [vcpkg\_get\_program\_files\_platform\_bitness](vcpkg_get_program_files_platform_bitness.md) - [vcpkg\_get\_windows\_sdk](vcpkg_get_windows_sdk.md) -- [vcpkg\_install\_cmake](vcpkg_install_cmake.md) +- [vcpkg\_install\_cmake](vcpkg_install_cmake.md) (deprecated, use [vcpkg\_cmake\_install](ports/vcpkg-cmake/vcpkg_cmake_install.md)) - [vcpkg\_install\_gn](vcpkg_install_gn.md) - [vcpkg\_install\_make](vcpkg_install_make.md) - [vcpkg\_install\_meson](vcpkg_install_meson.md) diff --git a/docs/maintainers/vcpkg_apply_patches.md b/docs/maintainers/vcpkg_apply_patches.md index 76197ecca..a3aad0714 100644 --- a/docs/maintainers/vcpkg_apply_patches.md +++ b/docs/maintainers/vcpkg_apply_patches.md @@ -1,6 +1,6 @@ # vcpkg_apply_patches -**This function has been deprecated in favor of the `PATCHES` argument to `vcpkg_from_github()` et al.** +**This function has been deprecated in favor of the `PATCHES` argument to [`vcpkg_from_github()`](vcpkg_from_github.md) et al.** The latest version of this document lives in the [vcpkg repo](https://github.com/Microsoft/vcpkg/blob/master/docs/maintainers/vcpkg_apply_patches.md). diff --git a/docs/maintainers/vcpkg_build_cmake.md b/docs/maintainers/vcpkg_build_cmake.md index eb7cb6e50..380136c8f 100644 --- a/docs/maintainers/vcpkg_build_cmake.md +++ b/docs/maintainers/vcpkg_build_cmake.md @@ -1,8 +1,8 @@ # vcpkg_build_cmake -The latest version of this document lives in the [vcpkg repo](https://github.com/Microsoft/vcpkg/blob/master/docs/maintainers/vcpkg_build_cmake.md). +**This function has been deprecated in favor of [`vcpkg_cmake_build`](ports/vcpkg-cmake/vcpkg_cmake_build.md) from the vcpkg-cmake port.** -**This function has been deprecated in favor of `vcpkg_cmake_build` from the vcpkg-cmake port.** +The latest version of this document lives in the [vcpkg repo](https://github.com/Microsoft/vcpkg/blob/master/docs/maintainers/vcpkg_build_cmake.md). Build a cmake project. diff --git a/docs/maintainers/vcpkg_configure_cmake.md b/docs/maintainers/vcpkg_configure_cmake.md index fd434cf22..195017b3c 100644 --- a/docs/maintainers/vcpkg_configure_cmake.md +++ b/docs/maintainers/vcpkg_configure_cmake.md @@ -1,8 +1,8 @@ # vcpkg_configure_cmake -The latest version of this document lives in the [vcpkg repo](https://github.com/Microsoft/vcpkg/blob/master/docs/maintainers/vcpkg_configure_cmake.md). +**This function has been deprecated in favor of [`vcpkg_cmake_configure`](ports/vcpkg-cmake/vcpkg_cmake_configure.md) from the vcpkg-cmake port.** -**This function has been deprecated in favor of `vcpkg_cmake_configure` from the vcpkg-cmake port.** +The latest version of this document lives in the [vcpkg repo](https://github.com/Microsoft/vcpkg/blob/master/docs/maintainers/vcpkg_configure_cmake.md). Configure CMake for Debug and Release builds of a project. diff --git a/docs/maintainers/vcpkg_fixup_cmake_targets.md b/docs/maintainers/vcpkg_fixup_cmake_targets.md index 704ac4ad1..b9ca9c4d7 100644 --- a/docs/maintainers/vcpkg_fixup_cmake_targets.md +++ b/docs/maintainers/vcpkg_fixup_cmake_targets.md @@ -1,8 +1,8 @@ # vcpkg_fixup_cmake_targets -The latest version of this document lives in the [vcpkg repo](https://github.com/Microsoft/vcpkg/blob/master/docs/maintainers/vcpkg_fixup_cmake_targets.md). +**This function has been deprecated in favor of [`vcpkg_cmake_config_fixup`](ports/vcpkg-cmake-config/vcpkg_cmake_config_fixup.md) from the vcpkg-cmake-config port.** -**This function has been deprecated in favor of `vcpkg_cmake_config_fixup` from the vcpkg-cmake-config port.** +The latest version of this document lives in the [vcpkg repo](https://github.com/Microsoft/vcpkg/blob/master/docs/maintainers/vcpkg_fixup_cmake_targets.md). Merge release and debug CMake targets and configs to support multiconfig generators. diff --git a/docs/maintainers/vcpkg_install_cmake.md b/docs/maintainers/vcpkg_install_cmake.md index 10c9d0b32..f8d3b6107 100644 --- a/docs/maintainers/vcpkg_install_cmake.md +++ b/docs/maintainers/vcpkg_install_cmake.md @@ -1,8 +1,8 @@ # vcpkg_install_cmake -The latest version of this document lives in the [vcpkg repo](https://github.com/Microsoft/vcpkg/blob/master/docs/maintainers/vcpkg_install_cmake.md). +**This function has been deprecated in favor of [`vcpkg_cmake_install`](ports/vcpkg-cmake/vcpkg_cmake_install.md) from the vcpkg-cmake port.** -**This function has been deprecated in favor of `vcpkg_cmake_install` from the vcpkg-cmake port.** +The latest version of this document lives in the [vcpkg repo](https://github.com/Microsoft/vcpkg/blob/master/docs/maintainers/vcpkg_install_cmake.md). Build and install a cmake project. |
