From c247a7d21f5835d43b6eaa5507e1b34b6803c54c Mon Sep 17 00:00:00 2001 From: Bo Rydberg <2945606+bolry@users.noreply.github.com> Date: Mon, 11 Mar 2019 04:31:02 +0100 Subject: Fix minor spelling mistakes in documentation (#5620) --- docs/maintainers/vcpkg_build_msbuild.md | 2 +- docs/maintainers/vcpkg_install_msbuild.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/maintainers') diff --git a/docs/maintainers/vcpkg_build_msbuild.md b/docs/maintainers/vcpkg_build_msbuild.md index 862587eb4..9f458f352 100644 --- a/docs/maintainers/vcpkg_build_msbuild.md +++ b/docs/maintainers/vcpkg_build_msbuild.md @@ -1,6 +1,6 @@ # vcpkg_build_msbuild -Build an msbuild-based project. Deprecated in favor of `vcpkg_install_msbuild()`. +Build a msbuild-based project. Deprecated in favor of `vcpkg_install_msbuild()`. ## Usage ```cmake diff --git a/docs/maintainers/vcpkg_install_msbuild.md b/docs/maintainers/vcpkg_install_msbuild.md index 1de68ce70..46a92ddf7 100644 --- a/docs/maintainers/vcpkg_install_msbuild.md +++ b/docs/maintainers/vcpkg_install_msbuild.md @@ -1,6 +1,6 @@ # vcpkg_install_msbuild -Build and install an msbuild-based project. This replaces `vcpkg_build_msbuild()`. +Build and install a msbuild-based project. This replaces `vcpkg_build_msbuild()`. ## Usage ```cmake -- cgit v1.2.3 From f24bd414ceeed5f4faad80405b87da4394c02d63 Mon Sep 17 00:00:00 2001 From: Victor Romero Date: Mon, 11 Mar 2019 17:29:37 -0700 Subject: [docs] Add vcpkg functions usage examples (#5639) --- docs/maintainers/vcpkg_add_to_path.md | 7 ++++++- docs/maintainers/vcpkg_from_gitlab.md | 5 ++++- 2 files changed, 10 insertions(+), 2 deletions(-) (limited to 'docs/maintainers') 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) -- cgit v1.2.3