blob: f1bee5b847c17321d8a95fc3db260450e548390f [file] [log] [blame]
Chris Luke54ccf222016-07-25 16:38:11 -04001# Copyright (c) 2016 Comcast Cable Communications Management, LLC.
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at:
6#
7# http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14
15#
16# Build the documentation
17#
18
Chris Luke90f52bf2016-09-12 08:55:13 -040019# Default target
20.PHONY: all
21all: doxygen
22
Chris Luke54ccf222016-07-25 16:38:11 -040023# These should be passed in by the root Makefile
24WS_ROOT ?= $(CURDIR)/..
25BR ?= $(WS_ROOT)/build-root
Chris Luke36d25062016-09-22 20:52:26 -040026
27# We support MacOS for docs generation
28ifeq ($(shell uname),Darwin)
29OS_ID = darwin
30endif
31
32# Work out the OS if we haven't already
Chris Lukee0d802b2016-08-31 10:04:58 -040033OS_ID ?= $(shell grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
Chris Luke54ccf222016-07-25 16:38:11 -040034
35# Package dependencies
Damjan Marion6bbf83a2017-01-10 10:39:21 +010036DOC_DEB_DEPENDS = doxygen graphviz python-pyparsing python-jinja2
37DOC_RPM_DEPENDS = doxygen graphviz pyparsing python-jinja2
Marco Varlese85bb9172017-02-02 21:33:09 +010038DOC_SUSE_RPM_DEPENDS = doxygen graphviz python-pyparsing python-Jinja2
Chris Luke36d25062016-09-22 20:52:26 -040039DOC_MAC_BIN_DEPENDS = doxygen dot git
40DOC_MAC_PY_DEPENDS = pyparsing jinja2
Chris Luke54ccf222016-07-25 16:38:11 -040041
42# Doxygen configuration and our utility scripts
43DOXY_DIR ?= $(WS_ROOT)/doxygen
44
Chris Luke3b480932016-09-07 13:28:59 -040045# Primary source directories
Chris Lukefdc62ab2016-12-28 09:44:47 -050046DOXY_SRC ?= src
Chris Luke3b480932016-09-07 13:28:59 -040047DOXY_SRC_DIRECTORIES = \
Dave Barach138945f2019-07-03 10:04:44 -040048 $(shell find $(DOXY_SRC) -name '*.md' -print | xargs dirname \
49 | sort | uniq) \
Chris Lukefdc62ab2016-12-28 09:44:47 -050050 $(DOXY_SRC)/vppinfra \
51 $(DOXY_SRC)/svm \
52 $(DOXY_SRC)/vlib \
53 $(DOXY_SRC)/vlibapi \
54 $(DOXY_SRC)/vlibmemory \
Chris Lukefdc62ab2016-12-28 09:44:47 -050055 $(DOXY_SRC)/vnet \
56 $(DOXY_SRC)/vpp \
Pablo Camarillo4521afa2017-03-16 10:43:05 +010057 $(DOXY_SRC)/vpp-api \
58 $(DOXY_SRC)/examples
Chris Luke3b480932016-09-07 13:28:59 -040059
60# Input directories and files
61DOXY_INPUT ?= \
Chris Luke5ccbaa92016-09-14 12:42:54 -040062 $(wildcard $(WS_ROOT)/*.md) \
63 $(wildcard $(DOXY_DIR)/*.md) \
Chris Luke3b480932016-09-07 13:28:59 -040064 $(DOXY_SRC_DIRECTORIES) \
Chris Luke64ebb5f2017-09-27 15:09:48 -040065 $(DOXY_SRC)/plugins \
66 extras
Chris Luke54ccf222016-07-25 16:38:11 -040067
Chris Luke5ccbaa92016-09-14 12:42:54 -040068# Strip leading workspace path from input names
69DOXY_INPUT := $(subst $(WS_ROOT)/,,$(DOXY_INPUT))
70
Chris Luked4024f52016-09-06 09:32:36 -040071# Files to exclude, from pre-Doxygen steps, eg because they're
72# selectively compiled.
73# Examples would be to exclude non-DPDK related sources when
74# there's a DPDK equivalent that conflicts.
Chris Luke3b480932016-09-07 13:28:59 -040075# These must be left-anchored paths for the regexp below to work.
76DOXY_EXCLUDE ?= \
Ray Kinsella583dc8d2017-06-08 15:54:19 +010077 $(DOXY_SRC)/vpp-api/lua
Chris Luked4024f52016-09-06 09:32:36 -040078
79# Generate a regexp for filenames to exclude
Chris Luke3b480932016-09-07 13:28:59 -040080DOXY_EXCLUDE_REGEXP = ($(subst .,\.,$(shell echo '$(strip $(DOXY_EXCLUDE))' | sed -e 's/ /|/g')))
Chris Luked4024f52016-09-06 09:32:36 -040081
Chris Luke3b480932016-09-07 13:28:59 -040082# Include all the normal source directories in the include file path
83DOXY_INCLUDE_PATH = $(DOXY_SRC_DIRECTORIES)
84
Chris Luke3b480932016-09-07 13:28:59 -040085# Find API header directories and include them in the header path.
86# This is only useful if VPP and plugins are already built; nothing
87# here depends on those targets. We don't build documentation for these
88# header files, they're just added to the INCLUDE search path for Doxygen.
89_vpp_br = $(shell find "$(BR)" -maxdepth 1 -type d \
90 '(' -name build-vpp_debug-native -o -name build-vpp-native ')' -print \
91 | sed -e 's@^$(WS_ROOT)/*@@' -e 1q)
92ifneq ($(strip $(_vpp_br)),)
93DOXY_INCLUDE_PATH += \
94 $(_vpp_br)/vlib-api \
95 $(_vpp_br)/vpp
96# Also include any plugin directories that exist
97DOXY_INCLUDE_PATH += \
98 $(shell find $(WS_ROOT)/$(_vpp_br)/plugins -maxdepth 1 -type d | sed -e 's@^$(WS_ROOT)/*@@')
99endif
Chris Luked4024f52016-09-06 09:32:36 -0400100
101# Discover if we have CPP available
Chris Luke3b480932016-09-07 13:28:59 -0400102_cpp = $(shell which cpp)
103ifneq ($(strip $(_cpp)),)
104# Add whatever directories CPP normally includes to the header path
105DOXY_INCLUDE_PATH += $(shell set -e; $(_cpp) -v </dev/null 2>&1 | awk 'f&&/^ /{print $$1} /^\#include/{f=1}')
Chris Luked4024f52016-09-06 09:32:36 -0400106endif
Chris Luke16bcf7d2016-09-01 14:31:46 -0400107
Chris Luke54ccf222016-07-25 16:38:11 -0400108# Target directory for doxygen output
109DOXY_OUTPUT ?= $(BR)/docs
110
111# Siphoned fragments end up in here
112SIPHON_INPUT ?= $(DOXY_OUTPUT)/siphon_fragments
113
114# Siphoned fragements are processed into here
115SIPHON_OUTPUT ?= $(DOXY_OUTPUT)/siphon_docs
116
117# Extra document inputs that are processed in addition to DOXY_INPUT
118EXTRA_DOXY_INPUT += $(SIPHON_OUTPUT)
119
120# All the siphon types we know about
Chris Luke90f52bf2016-09-12 08:55:13 -0400121SIPHONS ?= clicmd syscfg
Chris Luke54ccf222016-07-25 16:38:11 -0400122
123SIPHON_FILES = $(addprefix $(SIPHON_INPUT)/,$(addsuffix .siphon,$(SIPHONS)))
124SIPHON_DOCS = $(addprefix $(SIPHON_OUTPUT)/,$(addsuffix .md,$(SIPHONS)))
Chris Lukec3f92ad2016-10-05 15:45:19 -0400125SIPHON_ITEMLIST = $(addprefix $(SIPHON_OUTPUT)/,$(addsuffix .itemlist,$(filter clicmd,$(SIPHONS))))
Chris Luke54ccf222016-07-25 16:38:11 -0400126
Chris Luke90f52bf2016-09-12 08:55:13 -0400127$(BR)/.doxygen-bootstrap.ok: Makefile
Damjan Marion6bbf83a2017-01-10 10:39:21 +0100128 @echo "Checking whether dependencies for Doxygen are installed..."
Chris Luke54ccf222016-07-25 16:38:11 -0400129ifeq ($(OS_ID),ubuntu)
Damjan Marion6bbf83a2017-01-10 10:39:21 +0100130 @set -e; inst=; \
131 for i in $(DOC_DEB_DEPENDS); do \
132 dpkg-query --show $$i >/dev/null 2>&1 || inst="$$inst $$i"; \
133 done; \
134 if [ "$$inst" ]; then \
135 sudo apt-get update; \
136 sudo apt-get $(CONFIRM) $(FORCE) install $$inst; \
137 fi
Chris Luke35425142016-09-09 20:16:04 -0400138 @if [ ! -s /usr/lib/graphviz/config6a ]; then \
Dave Wallacec8c53352017-02-17 00:10:53 -0500139 echo "Rebuilding system Graphviz configuration."; \
Chris Lukec87fa6d2016-09-09 17:51:42 -0400140 sudo dot -c; \
141 fi
Damjan Marion6bbf83a2017-01-10 10:39:21 +0100142else ifneq ("$(wildcard /etc/redhat-release)","")
143 @sudo yum install $(CONFIRM) $(DOC_RPM_DEPENDS)
Chris Luke36d25062016-09-22 20:52:26 -0400144else ifeq ($(OS_ID),darwin)
145 @set -e; \
146 for bin in $(DOC_MAC_BIN_DEPENDS); do \
147 which -s $${bin} || (\
148 echo "Program '$${bin}' not found, please install it."; \
149 false; \
150 ); \
151 done
152 @set -e; \
153 for py in $(DOC_MAC_PY_DEPENDS); do \
154 python -c "import $${py}" >/dev/null 2>&1 || (\
155 echo "Python package '$${py}' not found, please install it."; \
156 false; \
157 ); \
158 done
Marco Varlese85bb9172017-02-02 21:33:09 +0100159else ifeq ($(OS_ID),opensuse)
160 @sudo zypper install $(CONFIRM) $(DOC_SUSE_RPM_DEPENDS)
Chris Luke54ccf222016-07-25 16:38:11 -0400161else
Marco Varlese85bb9172017-02-02 21:33:09 +0100162 $(error "Building documentation currently works only on Ubuntu, CentOS, MacOS and OpenSUSE systems.")
Chris Luke54ccf222016-07-25 16:38:11 -0400163endif
164 @touch $@
165
166.PHONY: bootstrap-doxygen
167bootstrap-doxygen: $(BR)/.doxygen-bootstrap.ok
168
169.DELETE_ON_ERROR: $(BR)/.doxygen-siphon.dep
Chris Lukefdc62ab2016-12-28 09:44:47 -0500170$(BR)/.doxygen-siphon.dep: Makefile \
171 $(addprefix,$(WSROOT),$(DOXY_INPUT))
Chris Luke3b480932016-09-07 13:28:59 -0400172 @echo "Building siphon dependencies..."
Chris Lukefdc62ab2016-12-28 09:44:47 -0500173 @rm -f "$@"; for input in $(DOXY_INPUT); do \
174 [ -e "$(WS_ROOT)/$$input" ] && \
Chris Luke54ccf222016-07-25 16:38:11 -0400175 find "$(WS_ROOT)/$$input" -type f \
Chris Luked4024f52016-09-06 09:32:36 -0400176 \( -name '*.[ch]' -or -name '*.dox' \) -print \
Chris Luke3b480932016-09-07 13:28:59 -0400177 | grep -v -E '^$(WS_ROOT)/$(DOXY_EXCLUDE_REGEXP)' \
Chris Luked4024f52016-09-06 09:32:36 -0400178 | sed -e "s/^/\$$(SIPHON_FILES): /" \
179 >> $@; \
Chris Luke54ccf222016-07-25 16:38:11 -0400180 done
181
182# Include the source -> siphon dependencies
183-include $(BR)/.doxygen-siphon.dep
184
Chris Luke90f52bf2016-09-12 08:55:13 -0400185# Generate .siphon files that contain fragments of source file that
186# relate to the siphons we support.
Chris Luke54ccf222016-07-25 16:38:11 -0400187.NOTPARALLEL: $(SIPHON_FILES)
Damjan Marion6bbf83a2017-01-10 10:39:21 +0100188$(SIPHON_FILES): $(BR)/.doxygen-bootstrap.ok \
189 $(DOXY_DIR)/siphon-generate \
Chris Lukefdc62ab2016-12-28 09:44:47 -0500190 $(addprefix,$(WSROOT),$(DOXY_INPUT)) \
Chris Luke90f52bf2016-09-12 08:55:13 -0400191 $(wildcard $(DOXY_DIR)/siphon/*.py)
Chris Lukefdc62ab2016-12-28 09:44:47 -0500192 @echo "Validating source tree..."
193 @set -e; for input in $(DOXY_INPUT); do \
194 if [ ! -e "$(WS_ROOT)/$$input" ]; then \
195 echo "ERROR: Input path '$$input' does not exist." >&2; \
196 exit 1; \
197 fi; \
198 done
Chris Luke54ccf222016-07-25 16:38:11 -0400199 @rm -rf "$(SIPHON_INPUT)" "$(SIPHON_OUTPUT)"
200 @mkdir -p "$(SIPHON_INPUT)" "$(SIPHON_OUTPUT)"
Chris Luked4024f52016-09-06 09:32:36 -0400201 @touch $(SIPHON_INPUT)/files
Chris Luke3b480932016-09-07 13:28:59 -0400202 @echo "Collating source file list for siphoning..."
203 @for input in $(DOXY_INPUT); do \
Chris Luke54ccf222016-07-25 16:38:11 -0400204 cd "$(WS_ROOT)"; \
205 find "$$input" -type f \
Chris Luked4024f52016-09-06 09:32:36 -0400206 \( -name '*.[ch]' -or -name '*.dox' \) -print \
Chris Luke33356932017-05-10 11:40:27 -0400207 | grep -v -E '^src/examples/' \
Chris Luke3b480932016-09-07 13:28:59 -0400208 | grep -v -E '^$(DOXY_EXCLUDE_REGEXP)' \
Chris Luked4024f52016-09-06 09:32:36 -0400209 >> $(SIPHON_INPUT)/files; \
Chris Luke54ccf222016-07-25 16:38:11 -0400210 done
Chris Luke3b480932016-09-07 13:28:59 -0400211 @echo "Generating siphons..."
Chris Luke90f52bf2016-09-12 08:55:13 -0400212 @set -e; \
213 cd "$(WS_ROOT)"; \
214 $(DOXY_DIR)/siphon-generate \
Chris Luke54ccf222016-07-25 16:38:11 -0400215 --output="$(SIPHON_INPUT)" \
216 "@$(SIPHON_INPUT)/files"
217
Chris Lukec3f92ad2016-10-05 15:45:19 -0400218# Evaluate this to build a siphon doc output target for each desired
219# output type:
220# $(eval $(call siphon-process,file_extension,output_type_name))
221define siphon-process
222$(SIPHON_OUTPUT)/%.$(1): $(SIPHON_INPUT)/%.siphon \
Chris Luke90f52bf2016-09-12 08:55:13 -0400223 $(DOXY_DIR)/siphon-process \
224 $(wildcard $(DOXY_DIR)/siphon/*.py) \
Chris Lukec3f92ad2016-10-05 15:45:19 -0400225 $(wildcard $(DOXY_DIR)/siphon_templates/$(2)/*/*.$(1))
226 @echo "Processing siphon for $(2) from $$(notdir $$<)..."
Chris Luke90f52bf2016-09-12 08:55:13 -0400227 @set -e; \
228 cd "$(WS_ROOT)"; \
229 $(DOXY_DIR)/siphon-process \
Chris Lukec3f92ad2016-10-05 15:45:19 -0400230 --type=$$(basename $$(notdir $$<)) \
231 --format=$(2) \
232 --output="$$@" \
233 "$$<"
234endef
Chris Luke54ccf222016-07-25 16:38:11 -0400235
Chris Lukec3f92ad2016-10-05 15:45:19 -0400236# Process the .siphon source fragments and render them into doxygen flavored
237# markdown documentation
238.DELETE_ON_ERROR: $(SIPHON_DOCS)
239$(eval $(call siphon-process,md,markdown))
240
241# Process the .siphon source fragments and render them into a list of cli
242# commands.
243.DELETE_ON_ERROR: $(SIPHON_ITEMLIST)
244$(eval $(call siphon-process,itemlist,itemlist))
245
246# This target can be used just to generate the siphoned things
Chris Luke54ccf222016-07-25 16:38:11 -0400247.PHONY: doxygen-siphon
Damjan Marion6bbf83a2017-01-10 10:39:21 +0100248doxygen-siphon: $(SIPHON_DOCS) $(SIPHON_ITEMLIST)
Chris Luke54ccf222016-07-25 16:38:11 -0400249
250# Generate the doxygen docs
Chris Luke90f52bf2016-09-12 08:55:13 -0400251.PHONY: doxygen
Chris Luke54ccf222016-07-25 16:38:11 -0400252doxygen: $(SIPHON_DOCS)
253 @mkdir -p "$(DOXY_OUTPUT)"
Chris Luke3b480932016-09-07 13:28:59 -0400254 @echo "Running Doxygen..."
Chris Luke54ccf222016-07-25 16:38:11 -0400255 set -e; cd "$(WS_ROOT)"; \
256 ROOT="$(WS_ROOT)" \
257 BUILD_ROOT="$(BR)" \
258 INPUT="$(addprefix $(WS_ROOT)/,$(DOXY_INPUT)) $(EXTRA_DOXY_INPUT)" \
Chris Luke16bcf7d2016-09-01 14:31:46 -0400259 INCLUDE_PATH="$(DOXY_INCLUDE_PATH)" \
Chris Luke3b480932016-09-07 13:28:59 -0400260 EXCLUDE="$(DOXY_EXCLUDE)" \
Chris Luke54ccf222016-07-25 16:38:11 -0400261 HTML=YES \
262 VERSION="`git describe --tags --dirty`" \
263 doxygen $(DOXY_DIR)/doxygen.cfg
264
Chris Luke90f52bf2016-09-12 08:55:13 -0400265.PHONY: wipe-doxygen
Chris Luke54ccf222016-07-25 16:38:11 -0400266wipe-doxygen:
267 rm -rf "$(BR)/docs" "$(BR)/.doxygen-siphon.d"
268
Chris Luke90f52bf2016-09-12 08:55:13 -0400269.PHONY: clean
270clean: wipe-doxygen