vbatts/cri-o
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

docs: update documentation

Browse source 
Add documentation for the new configuration file format, as well as the
new `ocid config` subcommand and the changed --socket option.

Signed-off-by: Aleksa Sarai <asarai@suse.de>
This commit is contained in:
Aleksa Sarai 2016-10-10 04:36:43 +11:00
parent 9fb23bf0dc
commit 6860fe154a
No known key found for this signature in database
GPG key ID: 9E18AA267DDB8DB4
4 changed files with 107 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

17
Makefile
View file

@ -49,7 +49,7 @@ clean:
rm -f ${OCID_LINK}
rm -f conmon/conmon.o conmon/conmon
rm -f pause/pause.o pause/pause
rm -f docs/*.1 docs/*.8
rm -f docs/*.1 docs/*.5 docs/*.8
find . -name \*~ -delete
find . -name \#\* -delete
@ -73,30 +73,35 @@ binaries: ${OCID_LINK} ocid ocic conmon pause
MANPAGES_MD = $(wildcard docs/*.md)
docs/%.1: docs/%.1.md
docs/%.8: docs/%.8.md
@which go-md2man > /dev/null 2>/dev/null || (echo "ERROR: go-md2man not found. Consider 'make install.tools' target" && false)
$(GO_MD2MAN) -in $< -out $@.tmp && touch $@.tmp && mv $@.tmp $@
docs/%.8: docs/%.8.md
docs/%.5: docs/%.5.md
@which go-md2man > /dev/null 2>/dev/null || (echo "ERROR: go-md2man not found. Consider 'make install.tools' target" && false)
$(GO_MD2MAN) -in $< -out $@.tmp && touch $@.tmp && mv $@.tmp $@
docs: $(MANPAGES_MD:%.md=%)
install:
install:
install -D -m 755 ocid ${INSTALLDIR}/ocid
install -D -m 755 ocic ${INSTALLDIR}/ocic
install -D -m 755 conmon/conmon $(PREFIX)/libexec/ocid/conmon
install -D -m 755 pause/pause $(PREFIX)/libexec/ocid/pause
install -d $(PREFIX)/share/man/man8
install -m 644 $(basename $(MANPAGES_MD)) $(PREFIX)/share/man/man8
install -m 644 $(wildcard docs/*.8.md) $(PREFIX)/share/man/man8
install -d $(PREFIX)/share/man/man5
install -m 644 $(wildcard docs/*.5.md) $(PREFIX)/share/man/man5
uninstall:
rm -f ${INSTALLDIR}/{ocid,ocic}
rm -f $(PREFIX)/libexec/ocid/{conmon,pause}
for i in $(basename $(MANPAGES_MD)); do \
for i in $(wildcard docs/*.8.md); do \
rm -f $(PREFIX)/share/man/man8/$$(basename $${i}); \
done
for i in $(wildcard docs/*.5.md); do \
rm -f $(PREFIX)/share/man/man5/$$(basename $${i}); \
done
.PHONY: .gitvalidation
# When this is running in travis, it will only check the travis commit range