aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGriffin Downs <grdowns@microsoft.com>2019-03-12 11:29:31 -0700
committerGriffin Downs <grdowns@microsoft.com>2019-03-12 11:29:31 -0700
commitb29b874ae9007a4450b736cabbf3cd94a4ec6359 (patch)
tree09a031509ccb697d20dc0745bae6541bb694a2b0 /docs
parentfe626490f0f3537fc85f47f76d5bcd16ea539dea (diff)
parentf24bd414ceeed5f4faad80405b87da4394c02d63 (diff)
downloadvcpkg-b29b874ae9007a4450b736cabbf3cd94a4ec6359.tar.gz
vcpkg-b29b874ae9007a4450b736cabbf3cd94a4ec6359.zip
Merge branch 'master' of https://github.com/microsoft/vcpkg into dev/grdowns/5580
Diffstat (limited to 'docs')
-rw-r--r--docs/about/faq.md2
-rw-r--r--docs/maintainers/vcpkg_add_to_path.md7
-rw-r--r--docs/maintainers/vcpkg_build_msbuild.md2
-rw-r--r--docs/maintainers/vcpkg_from_gitlab.md5
-rw-r--r--docs/maintainers/vcpkg_install_msbuild.md2
-rw-r--r--docs/specifications/export-command.md4
-rw-r--r--docs/specifications/feature-packages.md4
-rw-r--r--docs/users/integration.md2
8 files changed, 18 insertions, 10 deletions
diff --git a/docs/about/faq.md b/docs/about/faq.md
index b7c9d67c8..b83674d05 100644
--- a/docs/about/faq.md
+++ b/docs/about/faq.md
@@ -26,7 +26,7 @@ To see an example of this, look at [`ports\opengl\portfile.cmake`](https://githu
We currently target Windows Desktop (x86 and x64) as well as the Universal Windows Platform (x86, x64, and ARM). See `vcpkg help triplet` for the current list.
## Does Vcpkg run on Linux/OSX?
-Yes! We continously test on OSX and Ubuntu 16.04, however we know users have been successful with Arch, Fedora, and FreeBSD. If you have trouble with your favorite Linux distribution, let us know in an issue and we'd be happy to help!
+Yes! We continuously test on OSX and Ubuntu 16.04, however we know users have been successful with Arch, Fedora, and FreeBSD. If you have trouble with your favorite Linux distribution, let us know in an issue and we'd be happy to help!
## How do I use different versions of a library on one machine?
Within a single instance of Vcpkg (e.g. one set of `installed\`, `packages\`, `ports\` and so forth), you can only have one version of a library installed (otherwise, the headers would conflict with each other!). For those with experience with system-wide package managers, packages in Vcpkg correspond to the `X-dev` or `X-devel` packages.
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_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_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)
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
diff --git a/docs/specifications/export-command.md b/docs/specifications/export-command.md
index aaa95cb1c..4111bfed4 100644
--- a/docs/specifications/export-command.md
+++ b/docs/specifications/export-command.md
@@ -5,7 +5,7 @@
### A. Build once and share
Customers want to be able to build their set of required libraries once, and then distribute the resulting binaries to all members of the "group". This has been brought up in
-- Enterprise environments, in which there are dedicated teams to acquire libraries and then share them with other team to consume them
+- Enterprise environments, in which there are dedicated teams to acquire libraries and then share them with other teams to consume them
- Academic environments, in which the professor/teacher wants to build the required libraries and then provide them to all the students
- CI Systems, in which developers want to quickly distribute their exact set of dependencies to a cloud-based farm of build machines
@@ -167,6 +167,6 @@ Alice gives to Bob: a) The links to her project and b) The zip file "vcpkg-expor
## 5. Technical model
- Each exported library, must be accompanied with all of its dependencies, even if they are not explicitly specified in the `vcpkg export` command.
-- When exporting a library, a dependency graph will be built, similarly to install, to figure out which packages needs to be exported.
+- When exporting a library, a dependency graph will be built, similarly to install, to figure out which packages need to be exported.
- It is allowed to have packages from different triplets, so users can include 32/64-bit and dynamic/static binaries in the same export.
- The exported archives also include the files needed to integrate with MSBuild and/or CMake. \ No newline at end of file
diff --git a/docs/specifications/feature-packages.md b/docs/specifications/feature-packages.md
index 198a602ba..81afba080 100644
--- a/docs/specifications/feature-packages.md
+++ b/docs/specifications/feature-packages.md
@@ -1,6 +1,6 @@
# Proposal: Features / Feature packages (Feb 23 2017)
-**Note: this is the proposal as it was initially accepted and does not neccessarily reflect the current behavior.**
+**Note: this is the proposal as it was initially accepted and does not necessarily reflect the current behavior.**
## 1. Motivation
@@ -14,7 +14,7 @@ Therefore, there is significant value in enabling users to choose whether they f
The community around [OpenCV][] has built up a library of extensions called [OpenCV_contrib][]. However, these extensions are a source-level patch onto the main OpenCV codebase and therefore must be applied _during_ the core OpenCV build. Further confounding the problem, it is the author's understanding that these community extensions have only been developed with [CUDA][] enabled and cannot be built without that dependency.
-Therefore, if CUDA is disabled, OpenCV\_contrib must also be disabled. Likewise, when a user requests OpenCV\_contrib, CUDA must be enabled. It would be convienent, but not a requirement, to enable CUDA without enabling the community extensions.
+Therefore, if CUDA is disabled, OpenCV\_contrib must also be disabled. Likewise, when a user requests OpenCV\_contrib, CUDA must be enabled. It would be convenient, but not a requirement, to enable CUDA without enabling the community extensions.
Finally, these extensions add additional exports and headers which could be depended upon by other libraries. For maintainers, there must be a way to specify this requirement such that `vcpkg install mylib-depends-ocv-contrib` will verify/build/rebuild OpenCV with the community extensions enabled.
diff --git a/docs/users/integration.md b/docs/users/integration.md
index 6d56c7c70..cd5f61e9d 100644
--- a/docs/users/integration.md
+++ b/docs/users/integration.md
@@ -139,7 +139,7 @@ You can set `VCPKG_TARGET_TRIPLET` on the configure line:
```no-highlight
cmake ../my/project -DVCPKG_TARGET_TRIPLET=x64-windows-static -DCMAKE_TOOLCHAIN_FILE=...
```
-If you use `VCPKG_DEFAULT_TRIPLET` [environment variable](config-environment.md) to contoll the unqualified triplet in vcpkg command lines you can default `VCPKG_TARGET_TRIPLET` in CMake like [Using an environment variable instead of a command line option](#using-an-environment-variable-instead-of-a-command-line-option):
+If you use `VCPKG_DEFAULT_TRIPLET` [environment variable](config-environment.md) to control the unqualified triplet in vcpkg command lines you can default `VCPKG_TARGET_TRIPLET` in CMake like [Using an environment variable instead of a command line option](#using-an-environment-variable-instead-of-a-command-line-option):
```cmake
if(DEFINED ENV{VCPKG_DEFAULT_TRIPLET} AND NOT DEFINED VCPKG_TARGET_TRIPLET)