Skip to content

Commit 44f406a

Browse files
luncliffluncliff
committed
Merge branch 'master' into port/xnnpack
2 parents fd5d70e + 4ef97c2 commit 44f406a

43 files changed

Lines changed: 501 additions & 392 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/examples/versioning.getting-started.md‎

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -176,27 +176,19 @@ If you want to upgrade your dependencies, you can bump the minimum version const
176176

177177
#### **`builtin-baseline`**
178178

179+
```json
180+
{ "builtin-baseline": "b60f003ccf5fe8613d029f49f835c8929a66eb61" }
179181
```
180-
"builtin-baseline": "b60f003ccf5fe8613d029f49f835c8929a66eb61"
181-
```
182-
183-
This field declares the versioning baseline for all ports. Setting a baseline is required to enable versioning, otherwise you will get the current versions on the ports directory. You can run 'git rev-parse HEAD' to get the current commit of vcpkg and set it as the builtin-baseline. But what is a baseline? What does it do? Why is the value a SHA?
184-
185-
From the [versioning documentation](../users/versioning.md):
186182

187-
> The baseline references a commit within the vcpkg repository that
188-
establishes a minimum version on every dependency in the graph. If
189-
no other constraints are specified (directly or transitively),
190-
then the version from the baseline of the top level manifest will
191-
be used.
183+
This field declares the versioning baseline for all ports. Setting a baseline is required to enable versioning, otherwise you will get the current versions on the ports directory. You can run 'git rev-parse HEAD' to get the current commit of vcpkg and set it as the builtin-baseline. See the [`builtin-baseline` documentation](../users/versioning.md#builtin-baseline) for more information.
192184

193185
In our example, you can notice that we do not declare a version constraint for `zlib`; instead, the version is taken from the baseline. Internally, vcpkg will look in commit `b60f003ccf5fe8613d029f49f835c8929a66eb61` to find out what version of `zlib` was the latest at that point in time (in our case it was `1.2.11#9`).
194186

195187
During version resolution, baseline versions are treated as minimum version constraints. If you declare an explicit constraint that is lower than a baseline version, the explicit constraint will be upgraded to the baseline version.
196188

197189
For example, if we modified our dependencies like this:
198-
```
199-
"dependencies": [
190+
```json
191+
{ "dependencies": [
200192
{
201193
"name": "fmt",
202194
"version>=": "7.1.3"
@@ -205,7 +197,7 @@ For example, if we modified our dependencies like this:
205197
"name": "zlib",
206198
"version>=": "1.2.11#7"
207199
}
208-
]
200+
] }
209201
```
210202

211203
_NOTE: The value `1.2.11#7` represents version `1.2.11`, port version `7`._
@@ -224,7 +216,7 @@ The mechanism vcpkg provides for that scenario is `overrides`. When an override
224216

225217
Let's modify our example once more, this time to force vcpkg to use version `6.0.0` of `fmt`.
226218

227-
```
219+
```json
228220
{
229221
"name": "versions-test",
230222
"version": "1.0.0",
@@ -289,5 +281,4 @@ See also:
289281

290282
* [Versioning docs](../users/versioning.md)
291283
* [Original specification](../specifications/versioning.md)
292-
* [Versioning reference](../users/versioning.reference.md)
293284
* [Versioning implementation details](../users/versioning.implementation-details.md)

‎docs/maintainers/maintainer-guide.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ To update the files for all modified ports at once.
241241

242242
_NOTE: These commands require you to have committed your changes to the ports before running them. The reason is that the Git SHA of the port directory is required in these version files. But don't worry, the `x-add-version` command will warn you if you have local changes that haven't been committed._
243243

244-
See our [versioning specification](https://github.com/vicroms/vcpkg/blob/versioning-spec/docs/specifications/versioning.md) and [registries specification](https://github.com/strega-nil/vcpkg/blob/git-registries/docs/specifications/registries-2.md) to learn how vcpkg interacts with these files.
244+
See our [versioning specification](../specifications/versioning.md) and [registries specification](../specifications/registries-2.md) to learn how vcpkg interacts with these files.
245245

246246
## Patching
247247

‎docs/users/config-environment.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,9 @@ subject to change without notice and should be considered highly unstable.
1616

1717
Non-exhaustive list of off-by-default features:
1818

19-
- `binarycaching`
2019
- `manifest`
20+
- `versions`
21+
- `registries`
2122

2223
#### EDITOR
2324

‎docs/users/manifests.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ You shouldn't need to worry about this at all.
8888

8989
**Experimental behind the `versions` feature flag**
9090

91-
See [versioning.md](versioning.md#version%20schemes) for additional version types.
91+
See [versioning](versioning.md#version-schemes) for additional version types.
9292

9393
### `"description"`
9494

@@ -189,7 +189,7 @@ A minimum version constraint on the dependency.
189189

190190
This field specifies the minimum version of the dependency using a '#' suffix to denote port-version if non-zero.
191191

192-
See also [versioning](versioning.md#constraints) for more semantic details.
192+
See also [versioning](versioning.md#version-1) for more semantic details.
193193

194194
### `"overrides"`
195195

0 commit comments

Comments
 (0)