[vcpkg manifest] Add documentation!#13488
Merged
strega-nil merged 12 commits intomicrosoft:masterfrom Sep 14, 2020
Merged
Conversation
These are just for the maintainer docs, not user docs.
this modifies nothing about what strings are accepted or rejected, it just moves stuff around. also adds tests.
also fix tabs
c9684dc to
91b3ef7
Compare
strega-nil
commented
Sep 12, 2020
BillyONeal
requested changes
Sep 12, 2020
Member
BillyONeal
left a comment
There was a problem hiding this comment.
I'm not done reviewing yet; the thing I'm "request changes" over is the documentation of x- commands. In the case of x-set-installed IMO the previous explicit install/remove instructions were better for demonstrating how the tool works. In the case of x-format-manifest or similar, if we want users to use them, we should remove the x-.
ras0219
reviewed
Sep 13, 2020
strega-nil
added a commit
to strega-nil/vcpkg
that referenced
this pull request
May 5, 2021
* [vcpkg docs] add docs for manifest files These are just for the maintainer docs, not user docs. * [vcpkg] EBNF-ify platform expression parsing this modifies nothing about what strings are accepted or rejected, it just moves stuff around. also adds tests. * [vcpkg docs] add manifest mode example * [wip] docs for augustin also fix tabs * [vcpkg manifest] switch to using maps for features * Apply suggestions from code review * un-experimentize format-manifest * flesh out the user manifest mode docs * CRs * billy CRs * final personal pass-thru
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This adds documentation for manifest files and for manifest mode. It also converts the existing specification of the
supportsfield to an EBNF, since I think that's easier to read and more exact.There are two changes made to vcpkg manifests themselves as part of this documentation update:
$.featuresis now additionally allowed to be an object, and x-format-manifest will rewrite to this new object syntax.x-format-manifestis now a non-experimental commandExample:
{ "features": [ { "name": "foo", "description": "bar" } ] }gets rewritten to
{ "features": { "foo": { "description": "bar" } } }