MAP: Use bool type in map.api instead of u8.
[vpp.git] / Makefile
1 # Copyright (c) 2016 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
5 #
6 #     http://www.apache.org/licenses/LICENSE-2.0
7 #
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
13
14 export WS_ROOT=$(CURDIR)
15 export BR=$(WS_ROOT)/build-root
16 CCACHE_DIR?=$(BR)/.ccache
17 GDB?=gdb
18 PLATFORM?=vpp
19 SAMPLE_PLUGIN?=no
20 STARTUP_DIR?=$(PWD)
21 MACHINE=$(shell uname -m)
22 SUDO?=sudo
23
24 ,:=,
25 define disable_plugins
26 $(if $(1), \
27   "plugins {" \
28   $(patsubst %,"plugin %_plugin.so { disable }",$(subst $(,), ,$(1))) \
29   " }" \
30   ,)
31 endef
32
33 MINIMAL_STARTUP_CONF="                                                  \
34 unix {                                                                  \
35         interactive                                                     \
36         cli-listen /run/vpp/cli.sock                                    \
37         gid $(shell id -g)                                              \
38         $(if $(wildcard startup.vpp),"exec startup.vpp",)               \
39 }                                                                       \
40 $(if $(DPDK_CONFIG), "dpdk { $(DPDK_CONFIG) }",)                        \
41 $(call disable_plugins,$(DISABLED_PLUGINS))                             \
42 "
43
44 GDB_ARGS= -ex "handle SIGUSR1 noprint nostop"
45
46 #
47 # OS Detection
48 #
49 # We allow Darwin (MacOS) for docs generation; VPP build will still fail.
50 ifneq ($(shell uname),Darwin)
51 OS_ID        = $(shell grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
52 OS_VERSION_ID= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
53 endif
54
55 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
56 PKG=deb
57 else ifeq ($(filter rhel centos fedora opensuse opensuse-leap opensuse-tumbleweed,$(OS_ID)),$(OS_ID))
58 PKG=rpm
59 endif
60
61 # +libganglia1-dev if building the gmond plugin
62
63 DEB_DEPENDS  = curl build-essential autoconf automake ccache
64 DEB_DEPENDS += debhelper dkms git libtool libapr1-dev dh-systemd
65 DEB_DEPENDS += libconfuse-dev git-review exuberant-ctags cscope pkg-config
66 DEB_DEPENDS += lcov chrpath autoconf indent clang-format libnuma-dev
67 DEB_DEPENDS += python-all python-dev python-virtualenv python-pip libffi6 check
68 DEB_DEPENDS += libboost-all-dev libffi-dev python-ply libmbedtls-dev
69 DEB_DEPENDS += cmake ninja-build
70 ifeq ($(OS_VERSION_ID),14.04)
71         DEB_DEPENDS += openjdk-8-jdk-headless
72         DEB_DEPENDS += libssl-dev
73 else ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-8)
74         DEB_DEPENDS += openjdk-8-jdk-headless
75         DEB_DEPENDS += libssl-dev
76         APT_ARGS = -t jessie-backports
77 else ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-9)
78         DEB_DEPENDS += default-jdk-headless
79         DEB_DEPENDS += libssl1.0-dev
80 else
81         DEB_DEPENDS += default-jdk-headless
82         DEB_DEPENDS += libssl-dev
83 endif
84
85 RPM_DEPENDS  = redhat-lsb glibc-static java-1.8.0-openjdk-devel yum-utils
86 RPM_DEPENDS += apr-devel
87 RPM_DEPENDS += numactl-devel
88 RPM_DEPENDS += check check-devel
89 RPM_DEPENDS += boost boost-devel
90 RPM_DEPENDS += selinux-policy selinux-policy-devel
91 RPM_DEPENDS += cmake3 ninja-build
92
93 ifeq ($(OS_ID)-$(OS_VERSION_ID),fedora-25)
94         RPM_DEPENDS += subunit subunit-devel
95         RPM_DEPENDS += openssl-devel
96         RPM_DEPENDS += python-devel python2-ply
97         RPM_DEPENDS += python2-virtualenv
98         RPM_DEPENDS += mbedtls-devel
99         RPM_DEPENDS_GROUPS = 'C Development Tools and Libraries'
100 else ifeq ($(shell if [ "$(OS_ID)" = "fedora" ]; then test $(OS_VERSION_ID) -gt 25; echo $$?; fi),0)
101         RPM_DEPENDS += subunit subunit-devel
102         RPM_DEPENDS += compat-openssl10-devel
103         RPM_DEPENDS += python2-devel python2-ply
104         RPM_DEPENDS += python2-virtualenv
105         RPM_DEPENDS += mbedtls-devel
106         RPM_DEPENDS_GROUPS = 'C Development Tools and Libraries'
107 else
108         RPM_DEPENDS += openssl-devel
109         RPM_DEPENDS += python-devel python-ply
110         RPM_DEPENDS += python-virtualenv
111         RPM_DEPENDS += devtoolset-7
112         RPM_DEPENDS_GROUPS = 'Development Tools'
113 endif
114
115 # +ganglia-devel if building the ganglia plugin
116
117 RPM_DEPENDS += chrpath libffi-devel rpm-build
118
119 SUSE_NAME= $(shell grep '^NAME=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g' | cut -d' ' -f2)
120 SUSE_ID= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g' | cut -d' ' -f2)
121 RPM_SUSE_BUILDTOOLS_DEPS = autoconf automake ccache check-devel chrpath
122 RPM_SUSE_BUILDTOOLS_DEPS += clang cmake indent libtool make ninja python-ply
123
124 RPM_SUSE_DEVEL_DEPS = glibc-devel-static java-1_8_0-openjdk-devel libnuma-devel
125 RPM_SUSE_DEVEL_DEPS += libopenssl-devel openssl-devel mbedtls-devel
126
127 RPM_SUSE_PYTHON_DEPS = python-devel python3-devel python-pip python3-pip
128 RPM_SUSE_PYTHON_DEPS += python-rpm-macros python3-rpm-macros
129
130 RPM_SUSE_PLATFORM_DEPS = distribution-release shadow rpm-build
131
132 ifeq ($(OS_ID),opensuse)
133 ifeq ($(SUSE_NAME),Tumbleweed)
134         RPM_SUSE_DEVEL_DEPS = libboost_headers-devel libboost_thread-devel gcc
135         RPM_SUSE_PYTHON_DEPS += python2-ply python2-virtualenv
136 endif
137 ifeq ($(SUSE_ID),15.0)
138         RPM_SUSE_DEVEL_DEPS = libboost_headers-devel libboost_thread-devel gcc6
139         RPM_SUSE_PYTHON_DEPS += python2-ply python2-virtualenv
140 else
141         RPM_SUSE_DEVEL_DEPS += boost_1_61-devel gcc6
142         RPM_SUSE_PYTHON_DEPS += python-virtualenv
143 endif
144 endif
145
146 ifeq ($(OS_ID),opensuse-leap)
147 ifeq ($(SUSE_ID),15.0)
148         RPM_SUSE_DEVEL_DEPS = libboost_headers-devel libboost_thread-devel gcc6
149         RPM_SUSE_PYTHON_DEPS += python2-ply python2-virtualenv
150 endif
151 endif
152
153 RPM_SUSE_DEPENDS += $(RPM_SUSE_BUILDTOOLS_DEPS) $(RPM_SUSE_DEVEL_DEPS) $(RPM_SUSE_PYTHON_DEPS) $(RPM_SUSE_PLATFORM_DEPS)
154
155 ifneq ($(wildcard $(STARTUP_DIR)/startup.conf),)
156         STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
157 endif
158
159 ifeq ($(findstring y,$(UNATTENDED)),y)
160 CONFIRM=-y
161 FORCE=--force-yes
162 endif
163
164 TARGETS = vpp
165
166 ifneq ($(SAMPLE_PLUGIN),no)
167 TARGETS += sample-plugin
168 endif
169
170 .PHONY: help wipe wipe-release build build-release rebuild rebuild-release
171 .PHONY: run run-release debug debug-release build-vat run-vat pkg-deb pkg-rpm
172 .PHONY: ctags cscope
173 .PHONY: test test-debug retest retest-debug test-doc test-wipe-doc test-help test-wipe
174 .PHONY: test-cov test-wipe-cov
175
176 define banner
177         @echo "========================================================================"
178         @echo " $(1)"
179         @echo "========================================================================"
180         @echo " "
181 endef
182
183 help:
184         @echo "Make Targets:"
185         @echo " install-dep         - install software dependencies"
186         @echo " wipe                - wipe all products of debug build "
187         @echo " wipe-release        - wipe all products of release build "
188         @echo " build               - build debug binaries"
189         @echo " build-release       - build release binaries"
190         @echo " build-coverity      - build coverity artifacts"
191         @echo " rebuild             - wipe and build debug binares"
192         @echo " rebuild-release     - wipe and build release binares"
193         @echo " run                 - run debug binary"
194         @echo " run-release         - run release binary"
195         @echo " debug               - run debug binary with debugger"
196         @echo " debug-release       - run release binary with debugger"
197         @echo " test                - build and run (basic) functional tests"
198         @echo " test-debug          - build and run (basic) functional tests (debug build)"
199         @echo " test-all            - build and run (all) functional tests"
200         @echo " test-all-debug      - build and run (all) functional tests (debug build)"
201         @echo " test-shell          - enter shell with test environment"
202         @echo " test-shell-debug    - enter shell with test environment (debug build)"
203         @echo " test-wipe           - wipe files generated by unit tests"
204         @echo " retest              - run functional tests"
205         @echo " retest-debug        - run functional tests (debug build)"
206         @echo " test-help           - show help on test framework"
207         @echo " run-vat             - run vpp-api-test tool"
208         @echo " pkg-deb             - build DEB packages"
209         @echo " pkg-rpm             - build RPM packages"
210         @echo " install-ext-deps    - install external development dependencies"
211         @echo " ctags               - (re)generate ctags database"
212         @echo " gtags               - (re)generate gtags database"
213         @echo " cscope              - (re)generate cscope database"
214         @echo " checkstyle          - check coding style"
215         @echo " fixstyle            - fix coding style"
216         @echo " doxygen             - (re)generate documentation"
217         @echo " bootstrap-doxygen   - setup Doxygen dependencies"
218         @echo " wipe-doxygen        - wipe all generated documentation"
219         @echo " docs                 - Build the Sphinx documentation"
220         @echo " docs-venv         - Build the virtual environment for the Sphinx docs"
221         @echo " docs-clean        - Remove the generated files from the Sphinx docs"
222         @echo " test-doc            - generate documentation for test framework"
223         @echo " test-wipe-doc       - wipe documentation for test framework"
224         @echo " test-cov            - generate code coverage report for test framework"
225         @echo " test-wipe-cov       - wipe code coverage report for test framework"
226         @echo " test-checkstyle     - check PEP8 compliance for test framework"
227         @echo ""
228         @echo "Make Arguments:"
229         @echo " V=[0|1]                  - set build verbosity level"
230         @echo " STARTUP_CONF=<path>      - startup configuration file"
231         @echo "                            (e.g. /etc/vpp/startup.conf)"
232         @echo " STARTUP_DIR=<path>       - startup drectory (e.g. /etc/vpp)"
233         @echo "                            It also sets STARTUP_CONF if"
234         @echo "                            startup.conf file is present"
235         @echo " GDB=<path>               - gdb binary to use for debugging"
236         @echo " PLATFORM=<name>          - target platform. default is vpp"
237         @echo " TEST=<filter>            - apply filter to test set, see test-help"
238         @echo " DPDK_CONFIG=<conf>       - add specified dpdk config commands to"
239         @echo "                            autogenerated startup.conf"
240         @echo "                            (e.g. \"no-pci\" )"
241         @echo " SAMPLE_PLUGIN=yes        - in addition build/run/debug sample plugin"
242         @echo " DISABLED_PLUGINS=<list>  - comma separated list of plugins which"
243         @echo "                            should not be loaded"
244         @echo ""
245         @echo "Current Argument Values:"
246         @echo " V                 = $(V)"
247         @echo " STARTUP_CONF      = $(STARTUP_CONF)"
248         @echo " STARTUP_DIR       = $(STARTUP_DIR)"
249         @echo " GDB               = $(GDB)"
250         @echo " PLATFORM          = $(PLATFORM)"
251         @echo " DPDK_VERSION      = $(DPDK_VERSION)"
252         @echo " DPDK_CONFIG       = $(DPDK_CONFIG)"
253         @echo " SAMPLE_PLUGIN     = $(SAMPLE_PLUGIN)"
254         @echo " DISABLED_PLUGINS  = $(DISABLED_PLUGINS)"
255
256 $(BR)/.deps.ok:
257 ifeq ($(findstring y,$(UNATTENDED)),y)
258         make install-dep
259 endif
260 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
261         @MISSING=$$(apt-get install -y -qq -s $(DEB_DEPENDS) | grep "^Inst ") ; \
262         if [ -n "$$MISSING" ] ; then \
263           echo "\nPlease install missing packages: \n$$MISSING\n" ; \
264           echo "by executing \"make install-dep\"\n" ; \
265           exit 1 ; \
266         fi ; \
267         exit 0
268 else ifneq ("$(wildcard /etc/redhat-release)","")
269         @for i in $(RPM_DEPENDS) ; do \
270             RPM=$$(basename -s .rpm "$${i##*/}" | cut -d- -f1,2,3)  ;   \
271             MISSING+=$$(rpm -q $$RPM | grep "^package")    ;    \
272         done                                                       ;    \
273         if [ -n "$$MISSING" ] ; then \
274           echo "Please install missing RPMs: \n$$MISSING\n" ; \
275           echo "by executing \"make install-dep\"\n" ; \
276           exit 1 ; \
277         fi ; \
278         exit 0
279 endif
280         @touch $@
281
282 bootstrap:
283         @echo "'make bootstrap' is not needed anymore"
284
285 install-dep:
286 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
287 ifeq ($(OS_VERSION_ID),14.04)
288         @sudo -E apt-get $(CONFIRM) $(FORCE) install software-properties-common
289         @sudo -E add-apt-repository ppa:openjdk-r/ppa $(CONFIRM)
290 endif
291 ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-8)
292         @grep -q jessie-backports /etc/apt/sources.list /etc/apt/sources.list.d/* 2> /dev/null \
293            || ( echo "Please install jessie-backports" ; exit 1 )
294 endif
295         @sudo -E apt-get update
296         @sudo -E apt-get $(APT_ARGS) $(CONFIRM) $(FORCE) install $(DEB_DEPENDS)
297 else ifneq ("$(wildcard /etc/redhat-release)","")
298 ifeq ($(OS_ID),rhel)
299         @sudo -E yum-config-manager --enable rhel-server-rhscl-7-rpms
300 else ifeq ($(OS_ID),centos)
301         @sudo -E yum install $(CONFIRM) centos-release-scl-rh
302 endif
303         @sudo -E yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
304         @sudo -E yum install $(CONFIRM) $(RPM_DEPENDS)
305         @sudo -E debuginfo-install $(CONFIRM) glibc openssl-libs mbedtls-devel zlib
306 else ifeq ($(filter opensuse-tumbleweed,$(OS_ID)),$(OS_ID))
307         @sudo -E zypper refresh
308         @sudo -E zypper install -y $(RPM_SUSE_DEPENDS)
309 else ifeq ($(filter opensuse-leap,$(OS_ID)),$(OS_ID))
310         @sudo -E zypper refresh
311         @sudo -E zypper install -y $(RPM_SUSE_DEPENDS)
312 else ifeq ($(filter opensuse,$(OS_ID)),$(OS_ID))
313         @sudo -E zypper refresh
314         @sudo -E zypper install -y $(RPM_SUSE_DEPENDS)
315 else
316         $(error "This option currently works only on Ubuntu, Debian, RHEL, CentOS or openSUSE systems")
317 endif
318
319 define make
320         @make -C $(BR) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
321 endef
322
323 $(BR)/scripts/.version:
324 ifneq ("$(wildcard /etc/redhat-release)","")
325         $(shell $(BR)/scripts/version rpm-string > $(BR)/scripts/.version)
326 else
327         $(shell $(BR)/scripts/version > $(BR)/scripts/.version)
328 endif
329
330 DIST_FILE = $(BR)/vpp-$(shell src/scripts/version).tar
331 DIST_SUBDIR = vpp-$(shell src/scripts/version|cut -f1 -d-)
332
333 dist:
334         @if git rev-parse 2> /dev/null ; then \
335             git archive \
336               --prefix=$(DIST_SUBDIR)/ \
337               --format=tar \
338               -o $(DIST_FILE) \
339             HEAD ; \
340             git describe > $(BR)/.version ; \
341         else \
342             (cd .. ; tar -cf $(DIST_FILE) $(DIST_SUBDIR) --exclude=*.tar) ; \
343             src/scripts/version > $(BR)/.version ; \
344         fi
345         @tar --append \
346           --file $(DIST_FILE) \
347           --transform='s,.*/.version,$(DIST_SUBDIR)/src/scripts/.version,' \
348           $(BR)/.version
349         @$(RM) $(BR)/.version $(DIST_FILE).xz
350         @xz -v --threads=0 $(DIST_FILE)
351         @$(RM) $(BR)/vpp-latest.tar.xz
352         @ln -rs $(DIST_FILE).xz $(BR)/vpp-latest.tar.xz
353
354 build: $(BR)/.deps.ok
355         $(call make,$(PLATFORM)_debug,$(addsuffix -install,$(TARGETS)))
356
357 wipedist:
358         @$(RM) $(BR)/*.tar.xz
359
360 wipe: wipedist test-wipe $(BR)/.deps.ok
361         $(call make,$(PLATFORM)_debug,$(addsuffix -wipe,$(TARGETS)))
362
363 rebuild: wipe build
364
365 build-release: $(BR)/.deps.ok
366         $(call make,$(PLATFORM),$(addsuffix -install,$(TARGETS)))
367
368 wipe-release: test-wipe $(BR)/.deps.ok
369         $(call make,$(PLATFORM),$(addsuffix -wipe,$(TARGETS)))
370
371 rebuild-release: wipe-release build-release
372
373 export VPP_PYTHON_PREFIX ?= $(BR)/python
374
375 libexpand = $(subst $(subst ,, ),:,$(foreach lib,$(1),$(BR)/install-$(2)-native/vpp/$(lib)/$(3)))
376
377 define test
378         $(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=$(1) TAG=$(2) vpp-install,)
379         $(eval libs:=lib lib64)
380         make -C test \
381           TEST_DIR=$(WS_ROOT)/test \
382           VPP_TEST_BUILD_DIR=$(BR)/build-$(2)-native \
383           VPP_TEST_BIN=$(BR)/install-$(2)-native/vpp/bin/vpp \
384           VPP_TEST_PLUGIN_PATH=$(call libexpand,$(libs),$(2),vpp_plugins) \
385           VPP_TEST_INSTALL_PATH=$(BR)/install-$(2)-native/ \
386           LD_LIBRARY_PATH=$(call libexpand,$(libs),$(2),) \
387           EXTENDED_TESTS=$(EXTENDED_TESTS) \
388           PYTHON=$(PYTHON) \
389           OS_ID=$(OS_ID) \
390           CACHE_OUTPUT=$(CACHE_OUTPUT) \
391           $(3)
392 endef
393
394 test:
395         $(call test,vpp,vpp,test)
396
397 test-debug:
398         $(call test,vpp,vpp_debug,test)
399
400 test-all:
401         $(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=vpp TAG=vpp_debug vom-install japi-install,)
402         $(eval EXTENDED_TESTS=yes)
403         $(call test,vpp,vpp,test)
404
405 test-all-debug:
406         $(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=vpp TAG=vpp_debug vom-install japi-install,)
407         $(eval EXTENDED_TESTS=yes)
408         $(call test,vpp,vpp_debug,test)
409
410 test-help:
411         @make -C test help
412
413 test-wipe:
414         @make -C test wipe
415
416 test-shell:
417         $(call test,vpp,vpp,shell)
418
419 test-shell-debug:
420         $(call test,vpp,vpp_debug,shell)
421
422 test-dep:
423         @make -C test test-dep
424
425 test-doc:
426         @make -C test doc
427
428 test-wipe-doc:
429         @make -C test wipe-doc
430
431 test-cov:
432         $(eval EXTENDED_TESTS=yes)
433         $(call test,vpp,vpp_gcov,cov)
434
435 test-wipe-cov:
436         @make -C test wipe-cov
437
438 test-checkstyle:
439         @make -C test checkstyle
440
441 retest:
442         $(call test,vpp,vpp,retest)
443
444 retest-debug:
445         $(call test,vpp,vpp_debug,retest)
446
447 ifeq ("$(wildcard $(STARTUP_CONF))","")
448 define run
449         @echo "WARNING: STARTUP_CONF not defined or file doesn't exist."
450         @echo "         Running with minimal startup config: $(MINIMAL_STARTUP_CONF)\n"
451         @cd $(STARTUP_DIR) && \
452           $(SUDO) $(2) $(1)/vpp/bin/vpp $(MINIMAL_STARTUP_CONF)
453 endef
454 else
455 define run
456         @cd $(STARTUP_DIR) && \
457           $(SUDO) $(2) $(1)/vpp/bin/vpp $(shell cat $(STARTUP_CONF) | sed -e 's/#.*//')
458 endef
459 endif
460
461 %.files: .FORCE
462         @find . \( -name '*\.[chyS]' -o -name '*\.java' -o -name '*\.lex' \) -and \
463                 \( -not -path './build-root*' -o -path \
464                 './build-root/build-vpp_debug-native/dpdk*' \) > $@
465
466 .FORCE:
467
468 run:
469         $(call run, $(BR)/install-$(PLATFORM)_debug-native)
470
471 run-release:
472         $(call run, $(BR)/install-$(PLATFORM)-native)
473
474 debug:
475         $(call run, $(BR)/install-$(PLATFORM)_debug-native,$(GDB) $(GDB_ARGS) --args)
476
477 build-coverity:
478         $(call make,$(PLATFORM)_coverity,install-packages)
479
480 debug-release:
481         $(call run, $(BR)/install-$(PLATFORM)-native,$(GDB) $(GDB_ARGS) --args)
482
483 build-vat:
484         $(call make,$(PLATFORM)_debug,vpp-api-test-install)
485
486 run-vat:
487         @$(SUDO) $(BR)/install-$(PLATFORM)_debug-native/vpp/bin/vpp_api_test
488
489 pkg-deb:
490         $(call make,$(PLATFORM),install-deb)
491
492 pkg-rpm: dist
493         make -C extras/rpm
494
495 pkg-srpm: dist
496         make -C extras/rpm srpm
497
498 dpdk-install-dev:
499         $(call banner,"This command is deprecated. Please use 'make install-ext-deps'")
500         make -C build/external install-$(PKG)
501
502 install-ext-deps:
503         make -C build/external install-$(PKG)
504
505 ctags: ctags.files
506         @ctags --totals --tag-relative -L $<
507         @rm $<
508
509 gtags: ctags
510         @gtags --gtagslabel=ctags
511
512 cscope: cscope.files
513         @cscope -b -q -v
514
515 checkstyle:
516         @build-root/scripts/checkstyle.sh
517
518 fixstyle:
519         @build-root/scripts/checkstyle.sh --fix
520
521 #
522 # Build the documentation
523 #
524
525 # Doxygen configuration and our utility scripts
526 export DOXY_DIR ?= $(WS_ROOT)/doxygen
527
528 define make-doxy
529         @OS_ID="$(OS_ID)" make -C $(DOXY_DIR) $@
530 endef
531
532 .PHONY: bootstrap-doxygen doxygen wipe-doxygen
533
534 bootstrap-doxygen:
535         $(call make-doxy)
536
537 doxygen:
538         $(call make-doxy)
539
540 wipe-doxygen:
541         $(call make-doxy)
542
543 # Sphinx Documents
544 export DOCS_DIR = $(WS_ROOT)/docs
545 export VENV_DIR = $(WS_ROOT)/sphinx_venv
546 export SPHINX_SCRIPTS_DIR = $(WS_ROOT)/docs/scripts
547
548 .PHONY: docs-venv docs docs-clean
549
550 docs-venv:
551         @($(SPHINX_SCRIPTS_DIR)/sphinx-make.sh venv)
552
553 docs: $(DOCS_DIR)
554         @($(SPHINX_SCRIPTS_DIR)/sphinx-make.sh html)
555
556 docs-clean:
557         @($(SPHINX_SCRIPTS_DIR)/sphinx-make.sh clean)
558
559 verify: install-dep $(BR)/.deps.ok install-ext-deps
560         $(call banner,"Building for PLATFORM=vpp using gcc")
561         @make -C build-root PLATFORM=vpp TAG=vpp wipe-all install-packages
562         $(call banner,"Building sample-plugin")
563         @make -C build-root PLATFORM=vpp TAG=vpp sample-plugin-install
564         $(call banner,"Building libmemif")
565         @make -C build-root PLATFORM=vpp TAG=vpp libmemif-install
566         $(call banner,"Building JAPI")
567         @make -C build-root PLATFORM=vpp TAG=vpp japi-install
568         $(call banner,"Building VOM")
569         @make -C build-root PLATFORM=vpp TAG=vpp vom-install
570         $(call banner,"Building $(PKG) packages")
571         @make pkg-$(PKG)
572 ifeq ($(OS_ID)-$(OS_VERSION_ID),ubuntu-18.04)
573         $(call banner,"Running tests")
574         @make COMPRESS_FAILED_TEST_LOGS=yes RETRIES=3 test
575 endif
576
577