github/containerd
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

Add basic manpages for ctr, containerd, containerd-config

Browse Source 
Adds initial manpages for ctr, containerd, and containerd config
commands, as well as the config.toml configuration file.

Adds targets to Makefile for generating and installing manpages.

Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com>
This commit is contained in:
Phil Estes
2018-01-30 20:06:58 -05:00
parent fc1913a5a6
commit 8f183b5ee9
6 changed files with 330 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
Makefile
View File

@@ -57,7 +57,7 @@ TEST_REQUIRES_ROOT_PACKAGES=$(filter \
# Project binaries.
COMMANDS=ctr containerd containerd-stress containerd-release
MANPAGES=ctr.1 containerd.1 config.toml.5 containerd-config.1 containerd-publish.1
MANPAGES=ctr.1 containerd.1 config.toml.5 containerd-config.1
GO_TAGS=$(if $(BUILDTAGS),-tags "$(BUILDTAGS)",)
GO_LDFLAGS=-ldflags '-s -w -X $(PKG)/version.Version=$(VERSION) -X $(PKG)/version.Revision=$(REVISION) -X $(PKG)/version.Package=$(PKG) $(EXTRA_LDFLAGS)'
@@ -83,7 +83,7 @@ BINARIES=$(addprefix bin/,$(COMMANDS))
TESTFLAGS ?= -v $(TESTFLAGS_RACE)
TESTFLAGS_PARALLEL ?= 8
.PHONY: clean all AUTHORS build binaries test integration generate protos checkprotos coverage ci check help install uninstall vendor release
.PHONY: clean all AUTHORS build binaries test integration generate protos checkprotos coverage ci check help install uninstall vendor release mandir install-man
.DEFAULT: default
all: binaries
@@ -158,7 +158,7 @@ bin/containerd-shim: cmd/containerd-shim FORCE # set !cgo and omit pie for a sta
binaries: $(BINARIES) ## build binaries
@echo "$(WHALE) $@"
manpages: mandir $(addprefix man/,$(MANPAGES))
man: mandir $(addprefix man/,$(MANPAGES))
@echo "$(WHALE) $@"
mandir:
@@ -168,6 +168,15 @@ man/%: docs/man/%.md FORCE
@echo "$(WHALE) $<"
go-md2man -in "$<" -out "$@"
define installmanpage
mkdir -p $(DESTDIR)/man/man$(2);
gzip -c $(1) >$(DESTDIR)/man/man$(2)/$(3).gz;
endef
install-man:
@echo "$(WHALE) $@"
$(foreach manpage,$(addprefix man/,$(MANPAGES)), $(call installmanpage,$(manpage),$(subst .,,$(suffix $(manpage))),$(notdir $(manpage))))
release: $(BINARIES)
@echo "$(WHALE) $@"
@rm -rf releases/$(RELEASE) releases/$(RELEASE).tar.gz