Generate varlink API documentation automatically#734
Closed
baude wants to merge 1 commit intocontainers:masterfrom
Closed
Generate varlink API documentation automatically#734baude wants to merge 1 commit intocontainers:masterfrom
baude wants to merge 1 commit intocontainers:masterfrom
Conversation
Collaborator
|
☔ The latest upstream changes (presumably 21ebdb5) made this pull request unmergeable. Please resolve the merge conflicts. |
Member
|
@baude looks like a rebase is needed. |
Using varlink's idl parser, we generate API documentation for the podman API relying on the .varlink file as the source. Signed-off-by: baude <[email protected]>
Member
Author
|
bot, retest this please |
Member
|
This LGTM once tests are green |
Member
Author
|
bot, retest this please |
Member
Author
Collaborator
|
📌 Commit db548c9 has been approved by |
Collaborator
|
⚡ Test exempted: pull fully rebased and already tested. |
wking
added a commit
to wking/libpod
that referenced
this pull request
Jun 22, 2018
The API.md and cmd/podman/varlink/ioprojectatomicpodman.go targets will continue to work regardless of the presence (or not) of 'varlink' is in BUILDTAGS. However, cmd/podman/varlink/ioprojectatomicpodman.go is now only required by the podman target when BUILDTAGS contains 'varlink'. API.md had also been an podman dependency since 5b2627d (Makefile: Drop find-godeps.sh for podman target, 2018-05-15, containers#776) when I expanded varlink_api_generate. It had been an indirect podman dependency (via varlink_api_generate) since 2526355 (Generate varlink API documentation automatically, 2018-05-07, containers#734). But the podman executable obviously doesn't depend on the Markdown file, so I'm removing that dependency here.
baude
pushed a commit
to baude/podman
that referenced
this pull request
Jun 22, 2018
The API.md and cmd/podman/varlink/ioprojectatomicpodman.go targets will continue to work regardless of the presence (or not) of 'varlink' is in BUILDTAGS. However, cmd/podman/varlink/ioprojectatomicpodman.go is now only required by the podman target when BUILDTAGS contains 'varlink'. API.md had also been an podman dependency since 5b2627d (Makefile: Drop find-godeps.sh for podman target, 2018-05-15, containers#776) when I expanded varlink_api_generate. It had been an indirect podman dependency (via varlink_api_generate) since 2526355 (Generate varlink API documentation automatically, 2018-05-07, containers#734). But the podman executable obviously doesn't depend on the Markdown file, so I'm removing that dependency here. Signed-off-by: baude <[email protected]>
rh-atomic-bot
pushed a commit
that referenced
this pull request
Jun 24, 2018
some platforms and operating systems do not have varlink. in those cases, we need to be able to turn off enablement of varlink in podman. this can now be done with BUILDTAGS passed to the build though perhaps in the future will be better. the default is to build with varlink Signed-off-by: baude <[email protected]> squash! make varlink optional for podman The API.md and cmd/podman/varlink/ioprojectatomicpodman.go targets will continue to work regardless of the presence (or not) of 'varlink' is in BUILDTAGS. However, cmd/podman/varlink/ioprojectatomicpodman.go is now only required by the podman target when BUILDTAGS contains 'varlink'. API.md had also been an podman dependency since 5b2627d (Makefile: Drop find-godeps.sh for podman target, 2018-05-15, #776) when I expanded varlink_api_generate. It had been an indirect podman dependency (via varlink_api_generate) since 2526355 (Generate varlink API documentation automatically, 2018-05-07, #734). But the podman executable obviously doesn't depend on the Markdown file, so I'm removing that dependency here. Signed-off-by: baude <[email protected]> squash! make varlink optional for podman The command-pointer approach will scale well if/when we add additional optional commands behind their own build tags, because those tags won't all be competing for the same getOptionalCommands namespace. Signed-off-by: W. Trevor King <[email protected]> Closes: #987 Approved by: rhatdan
github-actions
bot
added
the
locked - please file new issue/PR
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
4 participants
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.
Using varlink's idl parser, we generate API documentation for the podman
API relying on the .varlink file as the source.
Signed-off-by: baude [email protected]