-# Copyright (c) 2016 Cisco and/or its affiliates.
+# Copyright (c) 2021 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
DEB_DEPENDS += python3-venv # ensurepip
DEB_DEPENDS += python3-dev # needed for python3 -m pip install psutil
DEB_DEPENDS += libnl-3-dev libnl-route-3-dev
-# python3.6 on 16.04 requires python36-dev
+DEB_DEPENDS += enchant # for docs
LIBFFI=libffi6 # works on all but 20.04 and debian-testing
DEB_DEPENDS += python3-virtualenv
DEB_DEPENDS += libssl-dev
DEB_DEPENDS += libelf-dev # for libbpf (af_xdp)
- DEB_DEPENDS += clang-format-10
+ # TODO: change CLANG_FORMAT_VER default in extras/scripts/checkstyle.sh
+ # when clang-format-10 is removed
+ DEB_DEPENDS += clang-11 clang-format-11 clang-format-10
LIBFFI=libffi7
else ifeq ($(OS_VERSION_ID),20.10)
- DEB_DEPENDS += python3-virtualenv
- DEB_DEPENDS += libssl-dev
- DEB_DEPENDS += libelf-dev # for libbpf (af_xdp)
- DEB_DEPENDS += clang-format-10
- LIBFFI=libffi8ubuntu1
+ DEB_DEPENDS += python3-virtualenv
+ DEB_DEPENDS += libssl-dev
+ DEB_DEPENDS += libelf-dev # for libbpf (af_xdp)
+ # TODO: change CLANG_FORMAT_VER default in extras/scripts/checkstyle.sh
+ # when clang-format-10 is removed
+ DEB_DEPENDS += clang-11 clang-format-11 clang-format-10
+ LIBFFI=libffi8ubuntu1
else ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-10)
DEB_DEPENDS += python3-virtualenv virtualenv
DEB_DEPENDS += libssl-dev
RPM_DEPENDS += xmlto
RPM_DEPENDS += elfutils-libelf-devel
RPM_DEPENDS += libnl3-devel
+RPM_DEPENDS += enchant # for docs
ifeq ($(OS_ID),fedora)
RPM_DEPENDS += dnf-utils
@echo " checkstyle-test-diff - check test framework coding style (only changed files)"
@echo " checkstyle-api - check api for incompatible changes"
@echo " fixstyle - fix coding style"
- @echo " doxygen - (re)generate documentation"
- @echo " bootstrap-doxygen - setup Doxygen dependencies"
- @echo " wipe-doxygen - wipe all generated documentation"
+ @echo " doxygen - DEPRECATED - use 'make docs'"
+ @echo " bootstrap-doxygen - DEPRECATED"
+ @echo " wipe-doxygen - DEPRECATED"
@echo " checkfeaturelist - check FEATURE.yaml according to schema"
@echo " featurelist - dump feature list in markdown"
@echo " json-api-files - (re)-generate json api files"
.PHONY: test-doc
test-doc:
- @make -C test doc
+ @echo "make test-doc is DEPRECATED: use 'make docs'"
+ sleep 300
.PHONY: test-wipe-doc
test-wipe-doc:
- @make -C test wipe-doc
+ @echo "make test-wipe-doc is DEPRECATED"
+ sleep 300
.PHONY: test-cov
test-cov:
# Build the documentation
#
-# Doxygen configuration and our utility scripts
-export DOXY_DIR ?= $(WS_ROOT)/doxygen
-
-define make-doxy
- @OS_ID="$(OS_ID)" make -C $(DOXY_DIR) $@
-endef
-
.PHONY: bootstrap-doxygen
bootstrap-doxygen:
- $(call make-doxy)
+ @echo "make bootstrap-doxygen is DEPRECATED"
+ sleep 300
.PHONY: doxygen
-doxygen: bootstrap-doxygen
- $(call make-doxy)
+doxygen: docs
+ @echo "make doxygen is DEPRECATED: use 'make docs'"
+ sleep 300
.PHONY: wipe-doxygen
wipe-doxygen:
- $(call make-doxy)
+ @echo "make wipe-doxygen is DEPRECATED"
+ sleep 300
-# Sphinx Documents
-export DOCS_DIR = $(WS_ROOT)/docs
-export VENV_DIR = $(WS_ROOT)/sphinx_venv
-export SPHINX_SCRIPTS_DIR = $(WS_ROOT)/docs/scripts
-
-.PHONY: docs-venv
-docs-venv:
- @($(SPHINX_SCRIPTS_DIR)/sphinx-make.sh venv)
+.PHONY: docs-%
+docs-%:
+ @make -C $(WS_ROOT)/docs $*
.PHONY: docs
-docs: $(DOCS_DIR)
- @($(SPHINX_SCRIPTS_DIR)/sphinx-make.sh html)
-
-.PHONY: docs-clean
-docs-clean:
- @rm -rf $(DOCS_DIR)/_build
- @rm -rf $(VENV_DIR)
+docs:
+ @make -C $(WS_ROOT)/docs docs
.PHONY: pkg-verify
pkg-verify: install-dep $(BR)/.deps.ok install-ext-deps