1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
|
# Copyright (c) 2021 Comcast Cable Communications Management, LLC.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# Build the documentation
#
# Default target
.PHONY: all
all: siphon
# These should be passed in by the root Makefile
WS_ROOT ?= $(CURDIR)/../..
BR ?= $(WS_ROOT)/build-root
BUILDDIR ?= ${BR}/docs
BUILDDIR_SRC ?= ${BUILDDIR}/src
DOCS_DIR ?= ${WS_ROOT}/docs
# Tag used in github repository path.
# Change this when genearting for a release
VPP_TAG ?= master
REPOSITORY_URL ?= https://github.com/FDio/vpp/blob/$(VPP_TAG)/
# Doxygen configuration and our utility scripts
SCRIPTS_DIR ?= $(WS_ROOT)/docs/_scripts
# docs root directory
FEATURE_LIST_FILE = ${BUILDDIR_SRC}/aboutvpp/featurelist.md
# Siphoned fragements are processed into here
DOCS_GENERATED_DIR ?= $(BUILDDIR_SRC)/_generated
# Siphoned fragments end up in here
SIPHON_INPUT_DIR ?= $(DOCS_GENERATED_DIR)/fragments
DYNAMIC_RENDER_DIR ?= ${DOCS_GENERATED_DIR}/includes
# Primary source directories
SIPHON_SRC ?= $(WS_ROOT)/src
SIPHON_SRC_DIRECTORIES = \
$(shell find $(SIPHON_SRC) -name '*.md' -print | xargs dirname \
| sort | uniq) \
$(SIPHON_SRC)/vppinfra \
$(SIPHON_SRC)/svm \
$(SIPHON_SRC)/vlib \
$(SIPHON_SRC)/vlibapi \
$(SIPHON_SRC)/vlibmemory \
$(SIPHON_SRC)/vnet \
$(SIPHON_SRC)/vpp \
$(SIPHON_SRC)/vpp-api \
$(SIPHON_SRC)/examples
# Input directories and files
SIPHON_INPUT ?= \
$(wildcard $(WS_ROOT)/*.md) \
$(wildcard $(SCRIPTS_DIR)/*.md) \
$(SIPHON_SRC_DIRECTORIES) \
$(SIPHON_SRC)/plugins \
extras
# Strip leading workspace path from input names
SIPHON_INPUT := $(subst $(WS_ROOT)/,,$(SIPHON_INPUT))
# Files to exclude, from pre-Doxygen steps, eg because they're
# selectively compiled.
# Examples would be to exclude non-DPDK related sources when
# there's a DPDK equivalent that conflicts.
# These must be left-anchored paths for the regexp below to work.
SIPHON_EXCLUDE ?= \
$(SIPHON_SRC)/vpp-api/lua
# Generate a regexp for filenames to exclude
SIPHON_EXCLUDE_REGEXP = ($(subst .,\.,$(shell echo '$(strip $(SIPHON_EXCLUDE))' | sed -e 's/ /|/g')))
# Include all the normal source directories in the include file path
SIPHON_INCLUDE_PATH = $(SIPHON_SRC_DIRECTORIES)
# 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
# header files, they're just added to the INCLUDE search path for Doxygen.
_vpp_br = $(shell find "$(BR)" -maxdepth 1 -type d \
'(' -name build-vpp_debug-native -o -name build-vpp-native ')' -print \
| sed -e 's@^$(WS_ROOT)/*@@' -e 1q)
ifneq ($(strip $(_vpp_br)),)
SIPHON_INCLUDE_PATH += \
$(_vpp_br)/vlib-api \
$(_vpp_br)/vpp
# Also include any plugin directories that exist
SIPHON_INCLUDE_PATH += \
$(shell find $(WS_ROOT)/$(_vpp_br)/plugins -maxdepth 1 -type d | sed -e 's@^$(WS_ROOT)/*@@')
endif
# Discover if we have CPP available
_cpp = $(shell which cpp)
ifneq ($(strip $(_cpp)),)
# Add whatever directories CPP normally includes to the header path
SIPHON_INCLUDE_PATH += $(shell set -e; $(_cpp) -v </dev/null 2>&1 | awk 'f&&/^ /{print $$1} /^\#include/{f=1}')
endif
# All the siphon types we know about
SIPHONS ?= clicmd syscfg
SIPHON_FILES = $(addprefix $(SIPHON_INPUT_DIR)/,$(addsuffix .siphon,$(SIPHONS)))
SIPHON_DOCS = $(addprefix $(DOCS_GENERATED_DIR)/,$(addsuffix .rst,$(SIPHONS)))
BUILT_ON = $(shell date '+%d %B %Y')
VPP_VERSION = $(shell ${WS_ROOT}/src/scripts/version)
$(DOCS_GENERATED_DIR)/.featurelist.done:
@( \
cd $(WS_ROOT) && \
find . -name FEATURE.yaml | \
./src/scripts/fts.py \
--markdown \
--repolink $(REPOSITORY_URL) > \
$(FEATURE_LIST_FILE) ; \
)
@touch $(DOCS_GENERATED_DIR)/.featurelist.done
$(DOCS_GENERATED_DIR)/.includes-render.done:
@mkdir -p "$(DYNAMIC_RENDER_DIR)"
@python3 $(SCRIPTS_DIR)/includes_renderer.py ${WS_ROOT} ${DYNAMIC_RENDER_DIR}
@touch $(DOCS_GENERATED_DIR)/.includes-render.done
$(DOCS_GENERATED_DIR)/.template-index.done:
@sed -ie "s/__VPP_VERSION__/${VPP_VERSION}/g" ${BUILDDIR_SRC}/index.rst
@sed -ie "s/__BUILT_ON__/${BUILT_ON}/g" ${BUILDDIR_SRC}/index.rst
@( \
for f in $$(grep -l -R __REPOSITORY_URL__ ${BUILDDIR_SRC} | grep -e '\.rst$$' -e '\.md$$' ) ;\
do \
if [ ! -z $${f} ]; then \
echo "TEMPLATING $${f}" ;\
sed -ie "s@__REPOSITORY_URL__@${REPOSITORY_URL}@g" $${f} ;\
fi ;\
done ; \
)
@touch $(DOCS_GENERATED_DIR)/.template-index.done
.NOTPARALLEL: $(SIPHON_FILES)
$(SIPHON_FILES): $(SCRIPTS_DIR)/siphon-generate \
$(addprefix,$(WSROOT),$(SIPHON_INPUT)) \
$(wildcard $(SCRIPTS_DIR)/siphon/*.py)
@echo "Validating source tree..."
@set -e; for input in $(SIPHON_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_DIR)" "$(DOCS_GENERATED_DIR)"
@mkdir -p "$(SIPHON_INPUT_DIR)" "$(DOCS_GENERATED_DIR)"
@touch $(SIPHON_INPUT_DIR)/files
@echo "Collating source file list for siphoning..."
@for input in $(SIPHON_INPUT); do \
cd "$(WS_ROOT)"; \
find "$$input" -type f \
\( -name '*.[ch]' -or -name '*.dox' \) -print \
| grep -v -E '^src/examples/' \
| grep -v -E '^$(SIPHON_EXCLUDE_REGEXP)' \
>> $(SIPHON_INPUT_DIR)/files; \
done
@echo "Generating siphons..."
@set -e; \
cd "$(WS_ROOT)"; \
$(SCRIPTS_DIR)/siphon-generate \
--output="$(SIPHON_INPUT_DIR)" \
"@$(SIPHON_INPUT_DIR)/files"
# Evaluate this to build a siphon doc output target for each desired
# output type:
# $(eval $(call siphon-process,file_extension,output_type_name))
define siphon-process
$(DOCS_GENERATED_DIR)/%.$(1): $(SIPHON_INPUT_DIR)/%.siphon \
$(SCRIPTS_DIR)/siphon-process \
$(wildcard $(SCRIPTS_DIR)/siphon/*.py) \
$(wildcard $(SCRIPTS_DIR)/siphon_templates/$(2)/*/*.$(1))
@echo "Processing siphon for $(2) from $$(notdir $$<)..."
@set -e; \
cd "$(WS_ROOT)"; \
mkdir -p $(DOCS_GENERATED_DIR)/$$(basename $$(notdir $$<)).$(1).dir; \
$(SCRIPTS_DIR)/siphon-process \
--type=$$(basename $$(notdir $$<)) \
--format=$(2) \
--repolink=$(REPOSITORY_URL)/ \
--outdir=$(DOCS_GENERATED_DIR)/$$(basename $$(notdir $$<)).$(1).dir \
--output="$$@" \
"$$<"
endef
# Process the .siphon source fragments and render them into siphon flavored
# markdown documentation
.DELETE_ON_ERROR: $(SIPHON_DOCS)
$(eval $(call siphon-process,rst,markdown))
# This target can be used just to generate the siphoned things
.PHONY: siphon
$(DOCS_GENERATED_DIR)/.siphon.done: $(SIPHON_DOCS)
@cp $(DOCS_GENERATED_DIR)/clicmd.rst $(BUILDDIR_SRC)/cli-reference/index.rst
@mkdir -p $(BUILDDIR_SRC)/cli-reference/clis
@cp -r $(DOCS_GENERATED_DIR)/clicmd.rst.dir/* $(BUILDDIR_SRC)/cli-reference/clis
@touch $(DOCS_GENERATED_DIR)/.siphon.done
.PHONY: clean-siphons
clean-siphons:
@( \
echo "find $(SIPHON_INPUT) -newer $(DOCS_GENERATED_DIR)/.siphon.done" ; \
cd $(WS_ROOT); \
if [ -f $(DOCS_GENERATED_DIR)/.siphon.done ] && \
[ $$(find $(SIPHON_INPUT) -type f -newer $(DOCS_GENERATED_DIR)/.siphon.done \
-not -name '*.md' \
-not -name '*.rst' | wc -l) -gt 0 ]; then \
rm -r $(DOCS_GENERATED_DIR); \
echo "removing... $(DOCS_GENERATED_DIR)"; \
fi; \
)
${BUILDDIR}/.docsrc.sync.ok:
@echo "Copying docs files..."
@cp -r $(DOCS_DIR) ${BUILDDIR_SRC}
@cd ${BUILDDIR_SRC} && find . -type l -exec cp --remove-destination -L ${DOCS_DIR}/{} {} \;
@touch $(BUILDDIR)/.docsrc.sync.ok
.PHONY: copy-src
copy-src: ${BUILDDIR}/.docsrc.sync.ok
@echo "Syncing changed files..."
@cd $(DOCS_DIR) && find . -type f -not -path '*/_scripts/*' -newer $(BUILDDIR)/.docsrc.sync.ok -exec cp {} ${BUILDDIR_SRC}/{} \;
@cd ${DOCS_DIR} && find . -type l -not -path '*/_scripts/*' -newer $(BUILDDIR)/.docsrc.sync.ok -exec cp --remove-destination -L ${DOCS_DIR}/{} ${BUILDDIR_SRC}/{} \;
@cd ${DOCS_DIR} && find -L . -type f -not -path '*/_scripts/*' -newer $(BUILDDIR)/.docsrc.sync.ok -exec cp --remove-destination -L ${DOCS_DIR}/{} ${BUILDDIR_SRC}/{} \;
@touch $(BUILDDIR)/.docsrc.sync.ok
.PHONY: generate
generate: copy-src clean-siphons $(DOCS_GENERATED_DIR)/.siphon.done $(DOCS_GENERATED_DIR)/.includes-render.done $(DOCS_GENERATED_DIR)/.template-index.done $(DOCS_GENERATED_DIR)/.featurelist.done
.PHONY: clean
clean:
@rm -rf $(BUILDDIR)
@rm -rf $(SCRIPTS_DIR)/siphon/__pycache__
|
