aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorVictor Romero <romerosanchezv@gmail.com>2019-03-11 17:29:37 -0700
committerGitHub <noreply@github.com>2019-03-11 17:29:37 -0700
commitf24bd414ceeed5f4faad80405b87da4394c02d63 (patch)
treec5589a3e15b68f9bda3e6552dd738af1e9c097b4 /docs
parentbe4158fb89045319f19d83d08b851e6e694b5b12 (diff)
downloadvcpkg-f24bd414ceeed5f4faad80405b87da4394c02d63.tar.gz
vcpkg-f24bd414ceeed5f4faad80405b87da4394c02d63.zip
[docs] Add vcpkg functions usage examples (#5639)
Diffstat (limited to 'docs')
-rw-r--r--docs/maintainers/vcpkg_add_to_path.md7
-rw-r--r--docs/maintainers/vcpkg_from_gitlab.md5
2 files changed, 10 insertions, 2 deletions
diff --git a/docs/maintainers/vcpkg_add_to_path.md b/docs/maintainers/vcpkg_add_to_path.md
index 3657a5ea7..b84f6b36f 100644
--- a/docs/maintainers/vcpkg_add_to_path.md
+++ b/docs/maintainers/vcpkg_add_to_path.md
@@ -16,5 +16,10 @@ Prepends the directory.
The default is to append.
+## Examples:
+* [curl][https://github.com/Microsoft/vcpkg/blob/master/ports/curl/portfile.cmake#L75]
+* [folly](https://github.com/Microsoft/vcpkg/blob/master/ports/folly/portfile.cmake#L15)
+* [z3](https://github.com/Microsoft/vcpkg/blob/master/ports/z3/portfile.cmake#L13)
+
## Source
-[scripts/cmake/vcpkg_add_to_path.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_add_to_path.cmake)
+[scripts/cmake/vcpkg_add_to_path.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_add_to_path.cmake)
diff --git a/docs/maintainers/vcpkg_from_gitlab.md b/docs/maintainers/vcpkg_from_gitlab.md
index bc312f37a..75ad95952 100644
--- a/docs/maintainers/vcpkg_from_gitlab.md
+++ b/docs/maintainers/vcpkg_from_gitlab.md
@@ -56,6 +56,9 @@ At least one of `REF` and `HEAD_REF` must be specified, however it is preferable
This exports the `VCPKG_HEAD_VERSION` variable during head builds.
+## Examples:
+
+* [tiny-process-library](https://github.com/Microsoft/vcpkg/blob/master/ports/tiny-process-library/portfile.cmake#L3)
## Source
-[scripts/cmake/vcpkg_from_gitlab.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_from_gitlab.cmake)
+[scripts/cmake/vcpkg_from_gitlab.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_from_gitlab.cmake)