Move API specification into correct position
The goal is to maintain a specification heirarchy under doc/spec. This change sets the example. The Makefile has also been changed update the AUTHORS file and can now generate the specification. Signed-off-by: Stephen J Day <stephen.day@docker.com>
This commit is contained in:
parent
10a194c775
commit
b429176dd7
5 changed files with 23 additions and 16 deletions
12
Makefile
12
Makefile
|
@ -6,10 +6,10 @@ GO_LDFLAGS=-ldflags "-X `go list ./version`.Version `git describe --match 'v[0-9
|
|||
|
||||
.PHONY: clean all fmt vet lint build test binaries
|
||||
.DEFAULT: default
|
||||
all: clean fmt vet fmt lint build test binaries
|
||||
all: AUTHORS clean fmt vet fmt lint build test binaries
|
||||
|
||||
AUTHORS: .mailmap .git/ORIG_HEAD .git/FETCH_HEAD .git/HEAD
|
||||
git log --format='%aN <%aE>' | sort -fu >> $@
|
||||
git log --format='%aN <%aE>' | sort -fu > $@
|
||||
|
||||
# This only needs to be generated by hand when cutting full releases.
|
||||
version/version.go:
|
||||
|
@ -18,6 +18,12 @@ version/version.go:
|
|||
${PREFIX}/bin/registry: version/version.go $(shell find . -type f -name '*.go')
|
||||
go build -o $@ ${GO_LDFLAGS} ./cmd/registry
|
||||
|
||||
${PREFIX}/bin/registry-api-descriptor-template: version/version.go $(shell find . -type f -name '*.go')
|
||||
go build -o $@ ${GO_LDFLAGS} ./cmd/registry-api-descriptor-template
|
||||
|
||||
doc/spec/api.md: doc/spec/api.md.tmpl ${PREFIX}/bin/registry-api-descriptor-template
|
||||
./bin/registry-api-descriptor-template $< > $@
|
||||
|
||||
vet:
|
||||
go vet ./...
|
||||
|
||||
|
@ -37,7 +43,7 @@ test:
|
|||
test-full:
|
||||
go test ./...
|
||||
|
||||
binaries: ${PREFIX}/bin/registry
|
||||
binaries: ${PREFIX}/bin/registry ${PREFIX}/bin/registry-api-descriptor-template
|
||||
|
||||
clean:
|
||||
rm -rf "${PREFIX}/bin/registry"
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue