aboutsummaryrefslogtreecommitdiff
path: root/scripts
diff options
context:
space:
mode:
authorautoantwort <41973254+autoantwort@users.noreply.github.com>2021-05-09 19:47:21 +0200
committerGitHub <noreply@github.com>2021-05-09 10:47:21 -0700
commitf44d4c169f1b81a6188b330dbd837881ffb9ef2b (patch)
treec976ce113fc24c1cbfc9feb6a7d8fab9a0844ee2 /scripts
parentcf2ea00e821b6cb197a3a3f9f5524ea05ed61e4a (diff)
downloadvcpkg-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 'scripts')
-rw-r--r--scripts/cmake/vcpkg_apply_patches.cmake2
-rw-r--r--scripts/cmake/vcpkg_build_cmake.cmake3
-rw-r--r--scripts/cmake/vcpkg_configure_cmake.cmake3
-rw-r--r--scripts/cmake/vcpkg_fixup_cmake_targets.cmake3
-rw-r--r--scripts/cmake/vcpkg_install_cmake.cmake3
5 files changed, 5 insertions, 9 deletions
diff --git a/scripts/cmake/vcpkg_apply_patches.cmake b/scripts/cmake/vcpkg_apply_patches.cmake
index bd4325af4..dae9e6018 100644
--- a/scripts/cmake/vcpkg_apply_patches.cmake
+++ b/scripts/cmake/vcpkg_apply_patches.cmake
@@ -1,4 +1,4 @@
-# DEPRECATED: in favor of the `PATCHES` argument to `vcpkg_from_github()` et al.
+# DEPRECATED: in favor of the `PATCHES` argument to [`vcpkg_from_github()`](vcpkg_from_github.md) et al.
#[===[.md
# vcpkg_apply_patches
diff --git a/scripts/cmake/vcpkg_build_cmake.cmake b/scripts/cmake/vcpkg_build_cmake.cmake
index 523999b4e..1bf89830e 100644
--- a/scripts/cmake/vcpkg_build_cmake.cmake
+++ b/scripts/cmake/vcpkg_build_cmake.cmake
@@ -1,8 +1,7 @@
+# DEPRECATED BY ports/vcpkg-cmake/vcpkg_cmake_build
#[===[.md:
# vcpkg_build_cmake
-**This function has been deprecated in favor of `vcpkg_cmake_build` from the vcpkg-cmake port.**
-
Build a cmake project.
## Usage:
diff --git a/scripts/cmake/vcpkg_configure_cmake.cmake b/scripts/cmake/vcpkg_configure_cmake.cmake
index 1cac9f015..fdf054e43 100644
--- a/scripts/cmake/vcpkg_configure_cmake.cmake
+++ b/scripts/cmake/vcpkg_configure_cmake.cmake
@@ -1,8 +1,7 @@
+# DEPRECATED BY ports/vcpkg-cmake/vcpkg_cmake_configure
#[===[.md:
# vcpkg_configure_cmake
-**This function has been deprecated in favor of `vcpkg_cmake_configure` from the vcpkg-cmake port.**
-
Configure CMake for Debug and Release builds of a project.
## Usage
diff --git a/scripts/cmake/vcpkg_fixup_cmake_targets.cmake b/scripts/cmake/vcpkg_fixup_cmake_targets.cmake
index f38270e8c..e6fbe785b 100644
--- a/scripts/cmake/vcpkg_fixup_cmake_targets.cmake
+++ b/scripts/cmake/vcpkg_fixup_cmake_targets.cmake
@@ -1,8 +1,7 @@
+# DEPRECATED BY ports/vcpkg-cmake-config/vcpkg_cmake_config_fixup
#[===[.md:
# vcpkg_fixup_cmake_targets
-**This function has been deprecated in favor of `vcpkg_cmake_config_fixup` from the vcpkg-cmake-config port.**
-
Merge release and debug CMake targets and configs to support multiconfig generators.
Additionally corrects common issues with targets, such as absolute paths and incorrectly placed binaries.
diff --git a/scripts/cmake/vcpkg_install_cmake.cmake b/scripts/cmake/vcpkg_install_cmake.cmake
index 82e6af05d..b94a3a484 100644
--- a/scripts/cmake/vcpkg_install_cmake.cmake
+++ b/scripts/cmake/vcpkg_install_cmake.cmake
@@ -1,8 +1,7 @@
+# DEPRECATED BY ports/vcpkg-cmake/vcpkg_cmake_install
#[===[.md:
# vcpkg_install_cmake
-**This function has been deprecated in favor of `vcpkg_cmake_install` from the vcpkg-cmake port.**
-
Build and install a cmake project.
## Usage: