build-root | Build output directory
doxygen | Documentation generator configuration
dpdk | DPDK patches and build infrastructure
- g2 | Event log visualization tool
- perftool | Performance tool
-@ref plugins | VPP bundled plugins directory
-@ref svm | Shared virtual memory allocation library
+@ref plugins | Not-yet-relocated VPP bundled plugins directory
+@ref src | VPP source code
+@ref src/plugins | VPP bundled plugins directory
+@ref src/svm | Shared virtual memory allocation library
+ src/tests | Unit tests
+ src/vat | VPP API test program
+@ref src/vlib | VPP application library
+@ref src/vlibapi | VPP API library
+@ref src/vlibmemory | VPP Memory management
+@ref src/vlibsocket | VPP Socket I/O
+@ref src/vnet | VPP networking
+@ref src/vpp | VPP application
+@ref src/vpp-api | VPP application API bindings
+@ref src/vppinfra | VPP core library
test | Unit tests
-@ref vlib | VPP application library source
-@ref vlib-api | VPP API library source
-@ref vnet | VPP networking source
-@ref vpp | VPP application source
-@ref vpp-api | VPP application API source
- vppapigen | VPP API generator source
- vpp-api-test | VPP API test program source
-@ref vppinfra | VPP core library source
-
-(If the page you are viewing is not generated by Doxygen then
-ignore any @@ref labels in the above table.)
+@ref vpp-api | Not-yet-relocated API bindings
## Getting started
DOXY_DIR ?= $(WS_ROOT)/doxygen
# Primary source directories
+DOXY_SRC ?= src
DOXY_SRC_DIRECTORIES = \
- vppinfra \
- svm \
- vlib \
- vlib-api \
- vnet \
- vpp \
+ $(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 \
vpp-api
# Input directories and files
$(wildcard $(WS_ROOT)/*.md) \
$(wildcard $(DOXY_DIR)/*.md) \
$(DOXY_SRC_DIRECTORIES) \
+ $(DOXY_SRC)/plugins \
plugins
# Strip leading workspace path from input names
# there's a DPDK equivalent that conflicts.
# These must be left-anchored paths for the regexp below to work.
DOXY_EXCLUDE ?= \
- vlib/vlib/buffer.c \
- vlib/example \
- plugins/sample-plugin
+ $(DOXY_SRC)/vlib/vlib/buffer.c \
+ $(DOXY_SRC)/vlib/example \
+ plugins/sample-plugin \
+ vpp-api/lua
# Generate a regexp for filenames to exclude
DOXY_EXCLUDE_REGEXP = ($(subst .,\.,$(shell echo '$(strip $(DOXY_EXCLUDE))' | sed -e 's/ /|/g')))
bootstrap-doxygen: $(BR)/.doxygen-bootstrap.ok
.DELETE_ON_ERROR: $(BR)/.doxygen-siphon.dep
-$(BR)/.doxygen-siphon.dep: Makefile
+$(BR)/.doxygen-siphon.dep: Makefile \
+ $(addprefix,$(WSROOT),$(DOXY_INPUT))
@echo "Building siphon dependencies..."
- @set -e; rm -f "$@"; for input in $(DOXY_INPUT); do \
+ @rm -f "$@"; for input in $(DOXY_INPUT); do \
+ [ -e "$(WS_ROOT)/$$input" ] && \
find "$(WS_ROOT)/$$input" -type f \
\( -name '*.[ch]' -or -name '*.dox' \) -print \
| grep -v -E '^$(WS_ROOT)/$(DOXY_EXCLUDE_REGEXP)' \
.NOTPARALLEL: $(SIPHON_FILES)
$(SIPHON_FILES): $(BR)/.doxygen-bootstrap.ok \
$(DOXY_DIR)/siphon-generate \
+ $(addprefix,$(WSROOT),$(DOXY_INPUT)) \
$(wildcard $(DOXY_DIR)/siphon/*.py)
+ @echo "Validating source tree..."
+ @set -e; for input in $(DOXY_INPUT); do \
+ if [ ! -e "$(WS_ROOT)/$$input" ]; then \
+ echo "ERROR: Input path '$$input' does not exist." >&2; \
+ exit 1; \
+ fi; \
+ done
@rm -rf "$(SIPHON_INPUT)" "$(SIPHON_OUTPUT)"
@mkdir -p "$(SIPHON_INPUT)" "$(SIPHON_OUTPUT)"
@touch $(SIPHON_INPUT)/files