VPP-57 Add Doxygen to VPP
[vpp.git] / Makefile
index fd1d0ff..dee2566 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -14,7 +14,6 @@
 WS_ROOT=$(CURDIR)
 BR=$(WS_ROOT)/build-root
 CCACHE_DIR?=$(BR)/.ccache
-V?=0
 GDB?=gdb
 PLATFORM?=vpp
 
@@ -22,19 +21,36 @@ MINIMAL_STARTUP_CONF="unix { interactive }"
 
 GDB_ARGS= -ex "handle SIGUSR1 noprint nostop"
 
+#
+# OS Detection
+#
+OS_ID        = $(shell grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
+OS_VERSION_ID= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
+
 DEB_DEPENDS  = curl build-essential autoconf automake bison libssl-dev ccache
-DEB_DEPENDS += debhelper dkms default-jdk git libtool libganglia1-dev libapr1-dev dh-systemd
+DEB_DEPENDS += debhelper dkms git libtool libganglia1-dev libapr1-dev dh-systemd
 DEB_DEPENDS += libconfuse-dev git-review exuberant-ctags cscope
+ifeq ($(OS_VERSION_ID),14.04)
+       DEB_DEPENDS += openjdk-8-jdk-headless
+else
+       DEB_DEPENDS += default-jdk-headless
+endif
 
 RPM_DEPENDS_GROUPS = 'Development Tools'
-RPM_DEPENDS  = redhat-lsb glibc-static java-1.8.0-openjdk-devel
+RPM_DEPENDS  = redhat-lsb glibc-static java-1.8.0-openjdk-devel yum-utils
 RPM_DEPENDS += openssl-devel https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm apr-devel
+#RPM_DEPENDS += doxygen # TODO
 EPEL_DEPENDS = libconfuse-devel ganglia-devel
+#EPEL_DEPENDS += graphviz # TODO
 
 ifneq ($(wildcard $(STARTUP_DIR)/startup.conf),)
         STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
 endif
 
+ifeq ($(findstring y,$(UNATTENDED)),y)
+CONFIRM=-y
+endif
+
 .PHONY: help bootstrap wipe wipe-release build build-release rebuild rebuild-release
 .PHONY: run run-release debug debug-release build-vat run-vat pkg-deb pkg-rpm
 .PHONY: ctags cscope
@@ -79,7 +95,7 @@ help:
        @echo " DPDK_VERSION = $(DPDK_VERSION)"
 
 $(BR)/.bootstrap.ok:
-ifeq ("$(shell lsb_release -si)", "Ubuntu")
+ifeq ($(OS_ID),ubuntu)
        @MISSING=$$(apt-get install -y -qq -s $(DEB_DEPENDS) | grep "^Inst ") ; \
        if [ -n "$$MISSING" ] ; then \
          echo "\nPlease install missing packages: \n$$MISSING\n" ; \
@@ -108,18 +124,24 @@ endif
 bootstrap: $(BR)/.bootstrap.ok
 
 install-dep:
-ifeq ("$(shell lsb_release -si)", "Ubuntu")
-       @sudo apt-get -y install $(DEB_DEPENDS)
+ifeq ($(OS_ID),ubuntu)
+ifeq ($(OS_VERSION_ID),14.04)
+       @sudo apt-get $(CONFIRM) install software-properties-common
+       @sudo add-apt-repository $(CONFIRM) ppa:openjdk-r/ppa
+       @sudo apt-get update
+endif
+       @sudo apt-get $(CONFIRM) install $(DEB_DEPENDS)
 else ifneq ("$(wildcard /etc/redhat-release)","")
-       @sudo yum groupinstall -y $(RPM_DEPENDS_GROUPS)
-       @sudo yum install -y $(RPM_DEPENDS)
-       @sudo yum install -y --enablerepo=epel $(EPEL_DEPENDS)
+       @sudo yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
+       @sudo yum install $(CONFIRM) $(RPM_DEPENDS)
+       @sudo yum install $(CONFIRM) --enablerepo=epel $(EPEL_DEPENDS)
+       @sudo debuginfo-install $(CONFIRM) glibc-2.17-106.el7_2.4.x86_64 openssl-libs-1.0.1e-51.el7_2.4.x86_64 zlib-1.2.7-15.el7.x86_64
 else
        $(error "This option currently works only on Ubuntu or Centos systems")
 endif
 
 define make
-       @make -C $(BR) V=$(V) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
+       @make -C $(BR) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
 endef
 
 build: $(BR)/.bootstrap.ok
@@ -188,3 +210,27 @@ ctags: ctags.files
 
 cscope: cscope.files
        @cscope -b -q -v
+
+
+DOXY_INPUT = \
+       README.md \
+       vppinfra \
+       svm \
+       vlib \
+       vlib-api \
+       vnet \
+       vpp \
+       vpp-api
+
+.PHONY: doxygen
+doxygen:
+       @mkdir -p "$(BR)/docs"
+       ROOT="$(WS_ROOT)" \
+            BUILD_ROOT="$(BR)" \
+            INPUT="$(addprefix $(WS_ROOT)/,$(DOXY_INPUT))" \
+            HTML=YES \
+            VERSION="`git describe --tags --dirty`" \
+            doxygen doxygen/doxygen.cfg
+
+wipe-doxygen:
+       rm -rf "$(BR)/docs"