OS_ID ?= $(shell grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
# Package dependencies
-DOC_DEB_DEPENDS = doxygen graphviz python-pyparsing python-jinja2
-DOC_RPM_DEPENDS = doxygen graphviz pyparsing python-jinja2
DOC_MAC_BIN_DEPENDS = doxygen dot git
DOC_MAC_PY_DEPENDS = pyparsing jinja2
$(DOXY_SRC)/vlibsocket \
$(DOXY_SRC)/vnet \
$(DOXY_SRC)/vpp \
- $(DOXY_SRC)/vpp-api \
- vpp-api
+ $(DOXY_SRC)/vpp-api
# Input directories and files
DOXY_INPUT ?= \
DOXY_EXCLUDE ?= \
$(DOXY_SRC)/vlib/vlib/buffer.c \
$(DOXY_SRC)/vlib/example \
- plugins/sample-plugin \
- vpp-api/lua
+ $(DOXY_SRC)/vpp-api/lua \
+ plugins/sample-plugin
# Generate a regexp for filenames to exclude
DOXY_EXCLUDE_REGEXP = ($(subst .,\.,$(shell echo '$(strip $(DOXY_EXCLUDE))' | sed -e 's/ /|/g')))
SIPHON_ITEMLIST = $(addprefix $(SIPHON_OUTPUT)/,$(addsuffix .itemlist,$(filter clicmd,$(SIPHONS))))
$(BR)/.doxygen-bootstrap.ok: Makefile
- @echo "Checking whether dependencies for Doxygen are installed..."
ifeq ($(OS_ID),ubuntu)
- @set -e; inst=; \
- for i in $(DOC_DEB_DEPENDS); do \
- dpkg-query --show $$i >/dev/null 2>&1 || inst="$$inst $$i"; \
- done; \
- if [ "$$inst" ]; then \
- sudo apt-get update; \
- sudo apt-get $(CONFIRM) $(FORCE) install $$inst; \
- fi
@if [ ! -s /usr/lib/graphviz/config6a ]; then \
- echo "Rebuidlding system Graphviz configuration."; \
+ echo "Rebuilding system Graphviz configuration."; \
sudo dot -c; \
fi
-else ifneq ("$(wildcard /etc/redhat-release)","")
- @sudo yum install $(CONFIRM) $(DOC_RPM_DEPENDS)
else ifeq ($(OS_ID),darwin)
@set -e; \
for bin in $(DOC_MAC_BIN_DEPENDS); do \
# Generate .siphon files that contain fragments of source file that
# relate to the siphons we support.
.NOTPARALLEL: $(SIPHON_FILES)
-$(SIPHON_FILES): $(BR)/.doxygen-bootstrap.ok \
- $(DOXY_DIR)/siphon-generate \
+$(SIPHON_FILES):$(DOXY_DIR)/siphon-generate \
$(addprefix,$(WSROOT),$(DOXY_INPUT)) \
$(wildcard $(DOXY_DIR)/siphon/*.py)
@echo "Validating source tree..."
# This target can be used just to generate the siphoned things
.PHONY: doxygen-siphon
-doxygen-siphon: $(SIPHON_DOCS) $(SIPHON_ITEMLIST)
+doxygen-siphon: $(SIPHON_DOCS)
+
+# This target is used generate list of cli commands for use with
+# the bash completion element for vppctl
+.PHONY: doxygen-siphon-list
+doxygen-siphon-list: $(SIPHON_ITEMLIST)
# Generate the doxygen docs
.PHONY: doxygen