-
Notifications
You must be signed in to change notification settings - Fork 74
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve registries documentation #429
base: main
Are you sure you want to change the base?
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The only thing this is 'request changes' over are the file format examples that are wrong, everything else is take it or leave it nitpicks.
| ---------- | ------ | ----------- | | ||
| `git-tree` | string | A Git calculated SHA used to retrieve the port version | | ||
| [`version`<br>`version-semver`<br>`version-date`<br>`version-string`](../reference/vcpkg-json.md#version) | string | Upstream version information | | ||
| [port-version](../reference/vcpkg-json.md#port-version) | integer | Port files revision | | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should add something like:
The
version
/verison-semver
/version-date
/version-string
andport-version
match the values in the port retrieved by thegit-tree
. For example:PS D:\vcpkg> Get-Content D:\vcpkg\versions\c-\curl.json -TotalCount 7 { "versions": [ { "git-tree": "6ef1763f3cbe570d6378632c9b5793479c37fb07", "version": "8.11.0", "port-version": 1 }, PS D:\vcpkg> git show 6ef1763f3cbe570d6378632c9b5793479c37fb07:vcpkg.json | Select-Object -First 5 { "name": "curl", "version": "8.11.0", "port-version": 1, "description": "A library for transferring data with URLs",
I'm torn on whether this is a 'must' situation. It's true that if a user is manually doing this they must ensure that they do this, but it's also true that we provide tooling that makes this an implementation detail most of the time.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we can add this to the "Recommended practices" section in the conceptual article.
Co-authored-by: Billy O'Neal <[email protected]>
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
Co-authored-by: Robert Schumacher <[email protected]> Co-authored-by: Billy O'Neal <[email protected]>
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
PRMerger Results
|
This PR contains major changes to the registry's documentation:
git-tree
SHA