X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=doxygen%2FMakefile;h=40646148ec6ae8fde0523881268c1faddc4caa78;hb=aab0604c47f9d6e3fadb894b3f081085833f62b3;hp=face5b448282a832af962eaca5ea5fee831eb36c;hpb=cb034b9b374927c7552e36dcbc306d8456b2a0cb;p=vpp.git

diff --git a/doxygen/Makefile b/doxygen/Makefile
index face5b44828..40646148ec6 100644
--- a/doxygen/Makefile
+++ b/doxygen/Makefile
@@ -33,8 +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 python-pyparsing python-jinja2
-DOC_RPM_DEPENDS = doxygen graphviz pyparsing python-jinja2
+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
 
@@ -42,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 ?= \
@@ -60,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))
@@ -71,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')))
@@ -82,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
@@ -140,7 +136,7 @@ ifeq ($(OS_ID),ubuntu)
 			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)","")
@@ -160,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 $@
 
@@ -206,6 +204,7 @@ $(SIPHON_FILES): $(BR)/.doxygen-bootstrap.ok \
 		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
@@ -265,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