Skip to content

Commit

Permalink
[docs] Fix TOCs, inline command (microsoft#26412)
Browse files Browse the repository at this point in the history
  • Loading branch information
ras0219-msft authored Aug 22, 2022
1 parent 9ff91df commit 179dbd0
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 21 deletions.
10 changes: 9 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
16 changes: 0 additions & 16 deletions docs/commands/index.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/examples/overlay-triplets-linux-dynamic.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Overlay triplets example
# Using Overlay Triplets

## Building dynamic libraries on Linux

Expand Down
2 changes: 1 addition & 1 deletion docs/users/android.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
6 changes: 4 additions & 2 deletions docs/users/versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
Expand Down Expand Up @@ -141,6 +142,7 @@ Example:

As part of a version constraint declaration, a port version can be specified by adding the suffix `#<port-version>`, in the previous example `1.2.11#9` refers to version `1.2.11` port version `9`.

<a id="overrides"></a>
### `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.

Expand Down

0 comments on commit 179dbd0

Please sign in to comment.