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 # Target directory for doxygen output
  44 DOXY_OUTPUT ?= $(BR)/docs
  45
  46 # Siphoned fragments end up in here
  47 SIPHON_INPUT ?= $(DOXY_OUTPUT)/siphon_fragments
  48
  49 # Siphoned fragements are processed into here
  50 SIPHON_OUTPUT ?= $(DOXY_OUTPUT)/siphon_docs
  51
  52 # Extra document inputs that are processed in addition to DOXY_INPUT
  53 EXTRA_DOXY_INPUT += $(SIPHON_OUTPUT)
  54
  55 # All the siphon types we know about
  56 SIPHONS ?= clicmd
  57
  58 SIPHON_FILES = $(addprefix $(SIPHON_INPUT)/,$(addsuffix .siphon,$(SIPHONS)))
  59 SIPHON_DOCS = $(addprefix $(SIPHON_OUTPUT)/,$(addsuffix .md,$(SIPHONS)))
  60
  61 $(BR)/.doxygen-bootstrap.ok:
  62 ifeq ($(OS_ID),ubuntu)
  63         @sudo -E apt-get $(CONFIRM) $(FORCE) install $(DOC_DEB_DEPENDS)
  64 else ifneq ("$(wildcard /etc/redhat-release)","")
  65         @sudo yum install $(CONFIRM) $(DOC_RPM_DEPENDS)
  66 else
  67         $(error "This option currently works only on Ubuntu or Centos systems")
  68 endif
  69         @touch $@
  70
  71 .PHONY: bootstrap-doxygen
  72 bootstrap-doxygen: $(BR)/.doxygen-bootstrap.ok
  73
  74 .DELETE_ON_ERROR: $(BR)/.doxygen-siphon.dep
  75 $(BR)/.doxygen-siphon.dep: Makefile
  76         set -e; rm -f "$@"; for input in $(DOXY_INPUT); do \
  77                 find "$(WS_ROOT)/$$input" -type f \
  78                         \( -name '*.[ch]' -or -name '*.dox' \) \
  79                         -print | sed -e "s/^/\$$(SIPHON_FILES): /" >> $@; \
  80         done
  81
  82 # Include the source -> siphon dependencies
  83 -include $(BR)/.doxygen-siphon.dep
  84
  85 .NOTPARALLEL: $(SIPHON_FILES)
  86 $(SIPHON_FILES): $(DOXY_DIR)/siphon_generate.py $(BR)/.doxygen-bootstrap.ok
  87         @rm -rf "$(SIPHON_INPUT)" "$(SIPHON_OUTPUT)"
  88         @mkdir -p "$(SIPHON_INPUT)" "$(SIPHON_OUTPUT)"
  89         set -e; for input in $(DOXY_INPUT); do \
  90                 cd "$(WS_ROOT)"; \
  91                 find "$$input" -type f \
  92                         \( -name '*.[ch]' -or -name '*.dox' \) \
  93                         -print >> $(SIPHON_INPUT)/files; \
  94         done
  95         set -e; cd "$(WS_ROOT)"; $(DOXY_DIR)/siphon_generate.py \
  96                 --output="$(SIPHON_INPUT)" \
  97                 "@$(SIPHON_INPUT)/files"
  98
  99
 100 .DELETE_ON_ERROR: $(SIPHON_DOCS)
 101 $(SIPHON_OUTPUT)/%.md: $(SIPHON_INPUT)/%.siphon $(DOXY_DIR)/siphon_process.py
 102         set -e; cd "$(WS_ROOT)"; \
 103                 $(DOXY_DIR)/siphon_process.py --type=$(basename $(notdir $<)) \
 104                         --output="$(SIPHON_OUTPUT)" $< > $@
 105
 106 # This target can be used just to generate the siphoned docs
 107 .PHONY: doxygen-siphon
 108 doxygen-siphon: $(SIPHON_DOCS)
 109
 110 # Generate the doxygen docs
 111 doxygen: $(SIPHON_DOCS)
 112         @mkdir -p "$(DOXY_OUTPUT)"
 113         set -e; cd "$(WS_ROOT)"; \
 114             ROOT="$(WS_ROOT)" \
 115             BUILD_ROOT="$(BR)" \
 116             INPUT="$(addprefix $(WS_ROOT)/,$(DOXY_INPUT)) $(EXTRA_DOXY_INPUT)" \
 117             HTML=YES \
 118             VERSION="`git describe --tags --dirty`" \
 119             doxygen $(DOXY_DIR)/doxygen.cfg
 120
 121 wipe-doxygen:
 122         rm -rf "$(BR)/docs" "$(BR)/.doxygen-siphon.d"
 123