diff --git a/docs/README.md b/docs/README.md index 6914dcd54b4767..5eec48b7cd5b2e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -11,10 +11,18 @@ Vcpkg helps you manage C and C++ libraries on Windows, Linux and MacOS. This too - [Packaging GitHub Repositories Example: libogg](examples/packaging-github-repos.md) - [Patching Example: Patching libpng to work for x64-uwp](examples/patching.md) - [Getting Started with Versioning](examples/versioning.getting-started.md) +- [Manifest Mode: CMake Example](examples/manifest-mode-cmake.md) +- [Pin old Boost Versions](examples/modify-baseline-to-pin-old-boost.md) +- [Using Overlay Triplets](examples/overlay-triplets-linux-dynamic.md) ### Command Line Reference -- [Command Line Reference](commands/index.md) +- [Common Options](commands/common-options.md) +- Commands + - [vcpkg install](commands/install.md) + - [vcpkg integrate](commands/integrate.md) + - [vcpkg remove](commands/remove.md) + - [vcpkg search](commands/search.md) ### User Help diff --git a/docs/commands/index.md b/docs/commands/index.md deleted file mode 100644 index 9e9af1a4731c8b..00000000000000 --- a/docs/commands/index.md +++ /dev/null @@ -1,16 +0,0 @@ -# vcpkg Command Line Reference - -**The latest version of this documentation is available on [GitHub](https://github.com/Microsoft/vcpkg/tree/master/docs/commands/index.md).** - -## Contents - -- [Common Options](common-options.md) -- Commands - - [vcpkg install](install.md) - - [vcpkg integrate](integrate.md) - - [vcpkg remove](remove.md) - - [vcpkg search](search.md) - -## Source - -The vcpkg command line is developed in a separate repository on GitHub: [microsoft/vcpkg-tool](https://github.com/microsoft/vcpkg-tool). Issues should be posted to [microsoft/vcpkg](https://github.com/microsoft/vcpkg/issues). diff --git a/docs/examples/overlay-triplets-linux-dynamic.md b/docs/examples/overlay-triplets-linux-dynamic.md index 5d79013377afb1..25872b724be5c0 100644 --- a/docs/examples/overlay-triplets-linux-dynamic.md +++ b/docs/examples/overlay-triplets-linux-dynamic.md @@ -1,4 +1,4 @@ -# Overlay triplets example +# Using Overlay Triplets ## Building dynamic libraries on Linux diff --git a/docs/users/android.md b/docs/users/android.md index b25099c1683629..25fa2745304045 100644 --- a/docs/users/android.md +++ b/docs/users/android.md @@ -216,6 +216,6 @@ endif() cmake .. -DVCPKG_TARGET_ANDROID=ON -DANDROID_ABI=armeabi-v7a ```` -## Consume libraries using vpckg, and Android prefab Archives (AAR files) +## Consume libraries using vcpkg, and Android prefab Archives (AAR files) See [prefab.md](../specifications/prefab.md) diff --git a/docs/users/versioning.md b/docs/users/versioning.md index 5f76b6ade239fd..d10c7ace69eec1 100644 --- a/docs/users/versioning.md +++ b/docs/users/versioning.md @@ -3,9 +3,9 @@ **The latest version of this documentation is available on [GitHub](https://github.com/Microsoft/vcpkg/tree/master/docs/users/versioning.md).** Versioning allows you to deterministically control the precise revisions of dependencies used by -your project from within your manifest file. +your project from within your manifest file. Versioning only applies to [Manifest Mode](manifests.md). -See our guide to [getting started with versioning](../examples/versioning.getting-started.md). +For an example with context, see our guide to [getting started with versioning](../examples/versioning.getting-started.md). ## Contents @@ -17,6 +17,7 @@ See our guide to [getting started with versioning](../examples/versioning.gettin * [Version constraints](#version-constraints) * [Baselines](#baselines) * [`version>=`](#version-gte) + * [`overrides`](#overrides) ## Version schemes Ports in vcpkg should attempt to follow the versioning conventions used by the package's authors. For that reason, when declaring a package's version the appropriate scheme should be used. @@ -141,6 +142,7 @@ Example: As part of a version constraint declaration, a port version can be specified by adding the suffix `#`, in the previous example `1.2.11#9` refers to version `1.2.11` port version `9`. + ### `overrides` Declaring an override forces vcpkg to ignore all other version constraints and use the version specified in the override. This is useful for pinning exact versions and for resolving version conflicts.