From: Joshua Watt <jpewhacker@gmail.com>
To: meta-ti@yoctoproject.org
Subject: [morty/rocko/master][PATCH] ti-pdk: Allow Doxygen generation to be optional
Date: Wed, 21 Feb 2018 15:53:05 -0600 [thread overview]
Message-ID: <20180221215305.19734-1-JPEWhacker@gmail.com> (raw)
Users can choose to completely disable doxygen generation in pdk recipes
by setting TI_PDK_DOXYGEN_SUPPORT = "0" in local.conf
Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
---
classes/ti-pdk.bbclass | 7 +++
...mk-Allow-doxygen-support-to-be-overridden.patch | 50 ++++++++++++++++++++++
recipes-ti/ti-pdk-build/ti-pdk-build-rtos_git.bb | 5 ++-
3 files changed, 61 insertions(+), 1 deletion(-)
create mode 100644 recipes-ti/ti-pdk-build/ti-pdk-build-rtos/0001-comp_mk-Allow-doxygen-support-to-be-overridden.patch
diff --git a/classes/ti-pdk.bbclass b/classes/ti-pdk.bbclass
index ab730a90..540a665c 100644
--- a/classes/ti-pdk.bbclass
+++ b/classes/ti-pdk.bbclass
@@ -59,17 +59,24 @@ TI_PDK_LIMIT_SOCS ?= ""
TI_PDK_LIMIT_BOARDS ?= ""
TI_PDK_MAKE_TARGET ?= "release"
TI_PDK_EXTRA_MAKE ?= ""
+TI_PDK_DOXYGEN_SUPPORT ?= "1"
TI_PDK_XDC_ARGS ?= "${TI_PDK_LIMIT_SOCS}"
PARALLEL_XDC = "--jobs=${BB_NUMBER_THREADS}"
PARALLEL_MAKE = ""
+def get_doxygen_support(d):
+ if d.getVar('TI_PDK_DOXYGEN_SUPPORT', True) == '1':
+ return ''
+ return 'DOXYGEN_SUPPORT=no'
+
EXTRA_OEMAKE = " \
LIMIT_SOCS="${TI_PDK_LIMIT_SOCS}" \
LIMIT_BOARDS="${TI_PDK_LIMIT_BOARDS}" \
LIMIT_CORES="${TI_PDK_LIMIT_CORES}" \
${TI_PDK_EXTRA_MAKE} \
+ ${@get_doxygen_support(d)} \
"
do_configure() {
diff --git a/recipes-ti/ti-pdk-build/ti-pdk-build-rtos/0001-comp_mk-Allow-doxygen-support-to-be-overridden.patch b/recipes-ti/ti-pdk-build/ti-pdk-build-rtos/0001-comp_mk-Allow-doxygen-support-to-be-overridden.patch
new file mode 100644
index 00000000..2a10d37e
--- /dev/null
+++ b/recipes-ti/ti-pdk-build/ti-pdk-build-rtos/0001-comp_mk-Allow-doxygen-support-to-be-overridden.patch
@@ -0,0 +1,50 @@
+From e5dfce58161aaee80ca45c3e992a059efac459d7 Mon Sep 17 00:00:00 2001
+From: Joshua Watt <JPEWhacker@gmail.com>
+Date: Wed, 21 Feb 2018 13:38:35 -0600
+Subject: [PATCH] comp_mk: Allow doxygen support to be overridden
+
+Support for Doxygen can be globally disabled by setting the
+DOXYGEN_SUPPORT environment variable to "no"
+
+Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
+---
+ comp_top.mk | 9 +++++++--
+ 1 file changed, 7 insertions(+), 2 deletions(-)
+
+diff --git a/comp_top.mk b/comp_top.mk
+index 28700ba..e331132 100644
+--- a/comp_top.mk
++++ b/comp_top.mk
+@@ -114,6 +114,11 @@ comp_FIRM_LIST_CLEAN = $(addsuffix _clean, $($(COMP)_FIRM_LIST))
+ comp_PKG_LIST_ALL_CLEAN = $(addsuffix _clean, $(comp_PKG_LIST_ALL))
+ comp_PKG_LIST_PACKAGE = $(addsuffix _package, $(comp_PKG_LIST_ALL))
+
++# If the component enables doxygen, this will evaluate to "yesyes" and doxygen
++# will be built. If this value is overridden by the user to any other value, or
++# $(COMP)_DOXYGEN_SUPPORT is not "yes", doxygen is not built.
++DOXYGEN_SUPPORT ?= yes$($(COMP)_DOXYGEN_SUPPORT)
++
+ .PHONY : apps appcores app_clean clean_appcores \
+ lib libcores lib_allendians lib_clean clean_libcores clean_lib_allendians \
+ all comp_libs comp_libs_clean examples examples_clean clean package $(comp_PKG_LIST_ALL) \
+@@ -230,7 +235,7 @@ xdc_meta_clean:
+ $(XDC) clean XDCBUILDCFG=config_mk.bld
+
+ doxygen:
+-ifeq ($($(COMP)_DOXYGEN_SUPPORT),yes)
++ifeq ($(DOXYGEN_SUPPORT),yesyes)
+ $(ECHO) Creating Doxygen API guide ...
+ @doxygen docs/Doxyfile
+ else
+@@ -238,7 +243,7 @@ else
+ endif
+
+ clean_doxygen:
+-ifeq ($($(COMP)_DOXYGEN_SUPPORT),yes)
++ifeq ($(DOXYGEN_SUPPORT),yesyes)
+ $(ECHO) cleaned Doxygen API guide ...
+ $(RM) -rf docs/doxygen
+ else
+--
+2.14.3
+
diff --git a/recipes-ti/ti-pdk-build/ti-pdk-build-rtos_git.bb b/recipes-ti/ti-pdk-build/ti-pdk-build-rtos_git.bb
index 0999b5c5..fbb82ace 100644
--- a/recipes-ti/ti-pdk-build/ti-pdk-build-rtos_git.bb
+++ b/recipes-ti/ti-pdk-build/ti-pdk-build-rtos_git.bb
@@ -15,7 +15,10 @@ PDK_BUILD_GIT_BRANCH = "master"
PDK_BUILD_SRCREV = "cbac264f08aa9cdc2cd533d1433ef57b922cccb5"
BRANCH = "${PDK_BUILD_GIT_BRANCH}"
-SRC_URI = "${PDK_BUILD_GIT_URI};protocol=${PDK_BUILD_GIT_PROTOCOL};branch=${BRANCH}"
+SRC_URI = "\
+ ${PDK_BUILD_GIT_URI};protocol=${PDK_BUILD_GIT_PROTOCOL};branch=${BRANCH} \
+ file://0001-comp_mk-Allow-doxygen-support-to-be-overridden.patch \
+ "
SRCREV = "${PDK_BUILD_SRCREV}"
--
2.14.3
next reply other threads:[~2018-02-21 21:53 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-02-21 21:53 Joshua Watt [this message]
2018-02-22 1:42 ` [morty/rocko/master][PATCH] ti-pdk: Allow Doxygen generation to be optional Denys Dmytriyenko
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180221215305.19734-1-JPEWhacker@gmail.com \
--to=jpewhacker@gmail.com \
--cc=meta-ti@yoctoproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.