From 25263558f10b5e2e246b2349b49b1585852d57b6 Mon Sep 17 00:00:00 2001 From: baude Date: Mon, 7 May 2018 17:09:11 -0500 Subject: Generate varlink API documentation automatically 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 Closes: #734 Approved by: baude --- Makefile | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'Makefile') diff --git a/Makefile b/Makefile index ce4ee65ff..abe3ea8de 100644 --- a/Makefile +++ b/Makefile @@ -87,7 +87,7 @@ test/copyimg/copyimg: .gopathok $(wildcard test/copyimg/*.go) test/checkseccomp/checkseccomp: .gopathok $(wildcard test/checkseccomp/*.go) $(GO) build $(LDFLAGS) -tags "$(BUILDTAGS) containers_image_ostree_stub" -o $@ $(PROJECT)/test/checkseccomp -podman: .gopathok $(shell hack/find-godeps.sh $(GOPKGDIR) cmd/podman $(PROJECT)) varlink_generate +podman: .gopathok $(shell hack/find-godeps.sh $(GOPKGDIR) cmd/podman $(PROJECT)) varlink_generate varlink_api_generate $(GO) build -i $(LDFLAGS_PODMAN) -tags "$(BUILDTAGS)" -o bin/$@ $(PROJECT)/cmd/podman clean: @@ -251,6 +251,7 @@ install.tools: .install.gitvalidation .install.gometalinter .install.md2man fi varlink_generate: .gopathok cmd/podman/varlink/ioprojectatomicpodman.go +varlink_api_generate: .gopathok API.md .PHONY: install.libseccomp.sudo install.libseccomp.sudo: @@ -262,6 +263,9 @@ install.libseccomp.sudo: cmd/podman/varlink/ioprojectatomicpodman.go: cmd/podman/varlink/io.projectatomic.podman.varlink $(GO) generate ./cmd/podman/varlink/... +API.md: cmd/podman/varlink/io.projectatomic.podman.varlink + $(GO) generate ./docs/... + validate: gofmt .gitvalidation .PHONY: \ -- cgit v1.2.3-54-g00ecf