-
Notifications
You must be signed in to change notification settings - Fork 6.6k
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
[vcpkg manifest] Add documentation! #13488
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
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'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-
.
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.
Thanks!
* [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 adds documentation for manifest files and for manifest mode. It also converts the existing specification of the
supports
field 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:
$.features
is now additionally allowed to be an object, and x-format-manifest will rewrite to this new object syntax.x-format-manifest
is now a non-experimental commandExample:
gets rewritten to