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