aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authornicole mazzuca <mazzucan@outlook.com>2021-05-17 11:08:33 -0700
committerGitHub <noreply@github.com>2021-05-17 11:08:33 -0700
commit253c561a2cb38f5e09510d5bed35bd50dacfbfc9 (patch)
treed532edfceffb5231ae3ab14795d1a078119816d1 /docs
parente6dcc079c81161786eb7b052209a2047e79f2c6c (diff)
downloadvcpkg-253c561a2cb38f5e09510d5bed35bd50dacfbfc9.tar.gz
vcpkg-253c561a2cb38f5e09510d5bed35bd50dacfbfc9.zip
[scripts-audit] gn buildsystem (#17776)
* [scripts-audit] Remove vcpkg_build_gn This command has never been used (git log -S"vcpkg_build_gn\(" gives no results outside of the file itself and docs) and so shrink the public interface surface * [scripts-audit] gn buildsystem * format * oops * aaaugh * cr
Diffstat (limited to 'docs')
-rw-r--r--docs/maintainers/portfile-functions.md1
-rw-r--r--docs/maintainers/vcpkg_build_gn.md19
-rw-r--r--docs/maintainers/vcpkg_install_gn.md6
3 files changed, 5 insertions, 21 deletions
diff --git a/docs/maintainers/portfile-functions.md b/docs/maintainers/portfile-functions.md
index ccc06db88..0b8e7f3b5 100644
--- a/docs/maintainers/portfile-functions.md
+++ b/docs/maintainers/portfile-functions.md
@@ -6,7 +6,6 @@
- [vcpkg\_add\_to\_path](vcpkg_add_to_path.md)
- [vcpkg\_apply\_patches](vcpkg_apply_patches.md) (deprecated)
- [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)
- [vcpkg\_build\_ninja](vcpkg_build_ninja.md)
diff --git a/docs/maintainers/vcpkg_build_gn.md b/docs/maintainers/vcpkg_build_gn.md
deleted file mode 100644
index b664b9c54..000000000
--- a/docs/maintainers/vcpkg_build_gn.md
+++ /dev/null
@@ -1,19 +0,0 @@
-# vcpkg_build_gn
-
-The latest version of this document lives in the [vcpkg repo](https://github.com/Microsoft/vcpkg/blob/master/docs/maintainers/vcpkg_build_gn.md).
-
-Build a GN project
-
-## Usage:
-```cmake
-vcpkg_build_gn(
- [TARGETS <target>...]
-)
-```
-
-## Parameters:
-### TARGETS
-Only build the specified targets.
-
-## Source
-[scripts/cmake/vcpkg\_build\_gn.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_build_gn.cmake)
diff --git a/docs/maintainers/vcpkg_install_gn.md b/docs/maintainers/vcpkg_install_gn.md
index 46018ffef..a0134b4a1 100644
--- a/docs/maintainers/vcpkg_install_gn.md
+++ b/docs/maintainers/vcpkg_install_gn.md
@@ -2,7 +2,9 @@
The latest version of this document lives in the [vcpkg repo](https://github.com/Microsoft/vcpkg/blob/master/docs/maintainers/vcpkg_install_gn.md).
-Installs a GN project
+Installs a GN project.
+
+In order to build a GN project without installing, use [`vcpkg_build_ninja()`].
## Usage:
```cmake
@@ -21,5 +23,7 @@ Only install the specified targets.
Note: includes must be handled separately
+[`vcpkg_build_ninja()`]: vcpkg_build_ninja.md
+
## Source
[scripts/cmake/vcpkg\_install\_gn.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_install_gn.cmake)