nat: use correct data types for memory sizes

[vpp.git] / doxygen / Makefile

diff --git a/doxygen/Makefile b/doxygen/Makefile
index 1808662..4064614 100644 (file)
--- a/doxygen/Makefile
+++ b/doxygen/Makefile
@@ -33,6 +33,9 @@ endif
 OS_ID ?= $(shell grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
 
 # Package dependencies
+DOC_DEB_DEPENDS = doxygen graphviz python3-pyparsing python3-jinja2
+DOC_RPM_DEPENDS = doxygen graphviz python3-pyparsing python3-jinja2
+DOC_SUSE_RPM_DEPENDS = doxygen graphviz python3-pyparsing python3-Jinja2
 DOC_MAC_BIN_DEPENDS = doxygen dot git
 DOC_MAC_PY_DEPENDS = pyparsing jinja2
 
@@ -40,17 +43,19 @@ DOC_MAC_PY_DEPENDS = pyparsing jinja2
 DOXY_DIR ?= $(WS_ROOT)/doxygen
 
 # Primary source directories
-DOXY_SRC ?= src
+DOXY_SRC ?= $(WS_ROOT)/src
 DOXY_SRC_DIRECTORIES = \
+       $(shell find $(DOXY_SRC) -name '*.md' -print | xargs dirname \
+       | sort | uniq) \
        $(DOXY_SRC)/vppinfra \
        $(DOXY_SRC)/svm \
        $(DOXY_SRC)/vlib \
        $(DOXY_SRC)/vlibapi \
        $(DOXY_SRC)/vlibmemory \
-       $(DOXY_SRC)/vlibsocket \
        $(DOXY_SRC)/vnet \
        $(DOXY_SRC)/vpp \
-       $(DOXY_SRC)/vpp-api
+       $(DOXY_SRC)/vpp-api \
+       $(DOXY_SRC)/examples
 
 # Input directories and files
 DOXY_INPUT ?= \
@@ -58,7 +63,7 @@ DOXY_INPUT ?= \
        $(wildcard $(DOXY_DIR)/*.md) \
        $(DOXY_SRC_DIRECTORIES) \
        $(DOXY_SRC)/plugins \
-       plugins
+       extras
 
 # Strip leading workspace path from input names
 DOXY_INPUT := $(subst $(WS_ROOT)/,,$(DOXY_INPUT))
@@ -69,10 +74,7 @@ DOXY_INPUT := $(subst $(WS_ROOT)/,,$(DOXY_INPUT))
 # there's a DPDK equivalent that conflicts.
 # These must be left-anchored paths for the regexp below to work.
 DOXY_EXCLUDE ?= \
-       $(DOXY_SRC)/vlib/vlib/buffer.c \
-       $(DOXY_SRC)/vlib/example \
-       $(DOXY_SRC)/vpp-api/lua \
-       plugins/sample-plugin
+       $(DOXY_SRC)/vpp-api/lua
 
 # Generate a regexp for filenames to exclude
 DOXY_EXCLUDE_REGEXP = ($(subst .,\.,$(shell echo '$(strip $(DOXY_EXCLUDE))' | sed -e 's/ /|/g')))
@@ -80,10 +82,6 @@ DOXY_EXCLUDE_REGEXP = ($(subst .,\.,$(shell echo '$(strip $(DOXY_EXCLUDE))' | se
 # Include all the normal source directories in the include file path
 DOXY_INCLUDE_PATH = $(DOXY_SRC_DIRECTORIES)
 
-# Also include any plugin directories that exist
-DOXY_INCLUDE_PATH += \
-       $(shell find $(WS_ROOT)/plugins -maxdepth 1 -type d | sed -e 's@^$(WS_ROOT)/*@@')
-
 # Find API header directories and include them in the header path.
 # This is only useful if VPP and plugins are already built; nothing
 # here depends on those targets. We don't build documentation for these
@@ -127,11 +125,22 @@ SIPHON_DOCS = $(addprefix $(SIPHON_OUTPUT)/,$(addsuffix .md,$(SIPHONS)))
 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 "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 \
@@ -147,8 +156,10 @@ else ifeq ($(OS_ID),darwin)
                        false; \
                ); \
        done
+else ifeq ($(OS_ID),opensuse)
+       @sudo zypper install $(CONFIRM) $(DOC_SUSE_RPM_DEPENDS)
 else
-       $(error "Building documentation currently works only on Ubuntu, CentOS or MacOS systems.")
+       $(error "Building documentation currently works only on Ubuntu, CentOS, MacOS and OpenSUSE systems.")
 endif
        @touch $@
 
@@ -174,7 +185,8 @@ $(BR)/.doxygen-siphon.dep: Makefile \
 # Generate .siphon files that contain fragments of source file that
 # relate to the siphons we support.
 .NOTPARALLEL: $(SIPHON_FILES)
-$(SIPHON_FILES):$(DOXY_DIR)/siphon-generate \
+$(SIPHON_FILES): $(BR)/.doxygen-bootstrap.ok \
+               $(DOXY_DIR)/siphon-generate \
                $(addprefix,$(WSROOT),$(DOXY_INPUT)) \
                $(wildcard $(DOXY_DIR)/siphon/*.py)
        @echo "Validating source tree..."
@@ -192,6 +204,7 @@ $(SIPHON_FILES):$(DOXY_DIR)/siphon-generate \
                cd "$(WS_ROOT)"; \
                find "$$input" -type f \
                        \( -name '*.[ch]' -or -name '*.dox' \) -print \
+                       | grep -v -E '^src/examples/' \
                        | grep -v -E '^$(DOXY_EXCLUDE_REGEXP)' \
                        >> $(SIPHON_INPUT)/files; \
        done
@@ -232,12 +245,7 @@ $(eval $(call siphon-process,itemlist,itemlist))
 
 # This target can be used just to generate the siphoned things
 .PHONY: doxygen-siphon
-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)
+doxygen-siphon: $(SIPHON_DOCS) $(SIPHON_ITEMLIST)
 
 # Generate the doxygen docs
 .PHONY: doxygen
@@ -256,7 +264,10 @@ doxygen: $(SIPHON_DOCS)
 
 .PHONY: wipe-doxygen
 wipe-doxygen:
-       rm -rf "$(BR)/docs" "$(BR)/.doxygen-siphon.d"
+       @rm -rf $(BR)/docs
+       @rm -rf $(BR)/.doxygen-siphon.dep
+       @rm -rf $(BR)/.doxygen-bootstrap.ok
+       @rm -rf $(DOXY_DIR)/siphon/__pycache__
 
 .PHONY: clean
 clean: wipe-doxygen