diff mbox series

doc: disable doxygen's HAVE_DOT tag

Message ID 20191022122552.30419-1-alialnu@mellanox.com (mailing list archive)
State Superseded, archived
Headers
Series doc: disable doxygen's HAVE_DOT tag |

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/Intel-compilation success Compilation OK
ci/travis-robot success Travis build: passed

Commit Message

Ali Alnubani Oct. 22, 2019, 12:25 p.m. UTC 
  Ubuntu ships with a patched version of doxygen that enables
HAVE_DOT. Enabling this option causes the warning:
"""
warning: Included by graph for 'rte_common.h' not generated,
too many nodes. Consider increasing DOT_GRAPH_MAX_NODES
"""
This reproduces with doxygen version 1.8.13 and
dot - graphviz version 2.40.1 on Ubuntu 18.04.

This will force doxygen not to assume that dot (part of Graphviz)
is installed, which is the default, and will result in dot not being used
for visualization. The other option is to increase DOT_GRAPH_MAX_NODES
to a value larger than 55.

See:
- http://changelogs.ubuntu.com/changelogs/pool/main/d/doxygen/doxygen_1.8.13-10/changelog
- http://www.doxygen.nl/manual/config.html#cfg_have_dot

Signed-off-by: Ali Alnubani <alialnu@mellanox.com>
---
 doc/api/doxy-api.conf.in | 2 ++
 1 file changed, 2 insertions(+)
diff mbox series

Patch

diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in
index 908cee8f7..8e6cff79a 100644
--- a/doc/api/doxy-api.conf.in
+++ b/doc/api/doxy-api.conf.in
@@ -98,3 +98,5 @@  GENERATE_HTML           = YES
 HTML_OUTPUT             = @HTML_OUTPUT@
 GENERATE_LATEX          = NO
 GENERATE_MAN            = NO
+
+HAVE_DOT                = NO