doxygen/Makefile

   1 # 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
  19 # These should be passed in by the root Makefile
  20 WS_ROOT ?= $(CURDIR)/..
  21 BR ?= $(WS_ROOT)/build-root
  22 OS_ID ?= $(shell grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
  23
  24 # Package dependencies
  25 DOC_DEB_DEPENDS = doxygen graphviz python-pyparsing
  26 DOC_RPM_DEPENDS = doxygen graphviz pyparsing
  27
  28 # Doxygen configuration and our utility scripts
  29 DOXY_DIR ?= $(WS_ROOT)/doxygen
  30
  31 # Input directories and files
  32 DOXY_INPUT ?= \
  33         README.md \
  34         vppinfra \
  35         svm \
  36         vlib \
  37         vlib-api \
  38         vnet \
  39         vpp \
  40         vpp-api \
  41         plugins
  42
  43 DOXY_INCLUDE_PATH = $(shell set -e; cd $(WS_ROOT); for item in $(DOXY_INPUT); do find $$item -type d; done)
  44 DOXY_INCLUDE_PATH += $(shell set -e; cpp -v </dev/null 2>&1 | grep -A 1000 '\#include' | awk '/^ /{print $$1}')
  45
  46 # Target directory for doxygen output
  47 DOXY_OUTPUT ?= $(BR)/docs
  48
  49 # Siphoned fragments end up in here
  50 SIPHON_INPUT ?= $(DOXY_OUTPUT)/siphon_fragments
  51
  52 # Siphoned fragements are processed into here
  53 SIPHON_OUTPUT ?= $(DOXY_OUTPUT)/siphon_docs
  54
  55 # Extra document inputs that are processed in addition to DOXY_INPUT
  56 EXTRA_DOXY_INPUT += $(SIPHON_OUTPUT)
  57
  58 # All the siphon types we know about
  59 SIPHONS ?= clicmd
  60
  61 SIPHON_FILES = $(addprefix $(SIPHON_INPUT)/,$(addsuffix .siphon,$(SIPHONS)))
  62 SIPHON_DOCS = $(addprefix $(SIPHON_OUTPUT)/,$(addsuffix .md,$(SIPHONS)))
  63
  64 $(BR)/.doxygen-bootstrap.ok:
  65 ifeq ($(OS_ID),ubuntu)
  66         @sudo -E apt-get $(CONFIRM) $(FORCE) install $(DOC_DEB_DEPENDS)
  67 else ifneq ("$(wildcard /etc/redhat-release)","")
  68         @sudo yum install $(CONFIRM) $(DOC_RPM_DEPENDS)
  69 else
  70         $(error "This option currently works only on Ubuntu or Centos systems")
  71 endif
  72         @touch $@
  73
  74 .PHONY: bootstrap-doxygen
  75 bootstrap-doxygen: $(BR)/.doxygen-bootstrap.ok
  76
  77 .DELETE_ON_ERROR: $(BR)/.doxygen-siphon.dep
  78 $(BR)/.doxygen-siphon.dep: Makefile
  79         set -e; rm -f "$@"; for input in $(DOXY_INPUT); do \
  80                 find "$(WS_ROOT)/$$input" -type f \
  81                         \( -name '*.[ch]' -or -name '*.dox' \) \
  82                         -print | sed -e "s/^/\$$(SIPHON_FILES): /" >> $@; \
  83         done
  84
  85 # Include the source -> siphon dependencies
  86 -include $(BR)/.doxygen-siphon.dep
  87
  88 .NOTPARALLEL: $(SIPHON_FILES)
  89 $(SIPHON_FILES): $(DOXY_DIR)/siphon_generate.py $(BR)/.doxygen-bootstrap.ok
  90         @rm -rf "$(SIPHON_INPUT)" "$(SIPHON_OUTPUT)"
  91         @mkdir -p "$(SIPHON_INPUT)" "$(SIPHON_OUTPUT)"
  92         set -e; for input in $(DOXY_INPUT); do \
  93                 cd "$(WS_ROOT)"; \
  94                 find "$$input" -type f \
  95                         \( -name '*.[ch]' -or -name '*.dox' \) \
  96                         -print >> $(SIPHON_INPUT)/files; \
  97         done
  98         set -e; cd "$(WS_ROOT)"; $(DOXY_DIR)/siphon_generate.py \
  99                 --output="$(SIPHON_INPUT)" \
 100                 "@$(SIPHON_INPUT)/files"
 101
 102
 103 .DELETE_ON_ERROR: $(SIPHON_DOCS)
 104 $(SIPHON_OUTPUT)/%.md: $(SIPHON_INPUT)/%.siphon $(DOXY_DIR)/siphon_process.py
 105         set -e; cd "$(WS_ROOT)"; \
 106                 $(DOXY_DIR)/siphon_process.py --type=$(basename $(notdir $<)) \
 107                         --output="$(SIPHON_OUTPUT)" $< > $@
 108
 109 # This target can be used just to generate the siphoned docs
 110 .PHONY: doxygen-siphon
 111 doxygen-siphon: $(SIPHON_DOCS)
 112
 113 # Generate the doxygen docs
 114 doxygen: $(SIPHON_DOCS)
 115         @mkdir -p "$(DOXY_OUTPUT)"
 116         set -e; cd "$(WS_ROOT)"; \
 117             ROOT="$(WS_ROOT)" \
 118             BUILD_ROOT="$(BR)" \
 119             INPUT="$(addprefix $(WS_ROOT)/,$(DOXY_INPUT)) $(EXTRA_DOXY_INPUT)" \
 120             INCLUDE_PATH="$(DOXY_INCLUDE_PATH)" \
 121             HTML=YES \
 122             VERSION="`git describe --tags --dirty`" \
 123             doxygen $(DOXY_DIR)/doxygen.cfg
 124
 125 wipe-doxygen:
 126         rm -rf "$(BR)/docs" "$(BR)/.doxygen-siphon.d"
 127