Skip to content

Doxygen: Increase DOT_GRAPH_MAX_NODES to 120 - #5978

Closed
singalsu wants to merge 1 commit into
thesofproject:mainfrom
singalsu:doxygen_address_too_many_nodes
Closed

Doxygen: Increase DOT_GRAPH_MAX_NODES to 120#5978
singalsu wants to merge 1 commit into
thesofproject:mainfrom
singalsu:doxygen_address_too_many_nodes

Conversation

@singalsu

Copy link
Copy Markdown
Collaborator

This avoids a currently happening error:

"error: Include graph for 'src_ipc4_int32_table.h' not generated,
too many nodes (89), threshold is 50. Consider increasing
DOT_GRAPH_MAX_NODES."

Signed-off-by: Seppo Ingalsuo seppo.ingalsuo@linux.intel.com

This avoids a currently happening error:
"error: Include graph for 'src_ipc4_int32_table.h' not generated,
too many nodes (89), threshold is 50. Consider increasing
DOT_GRAPH_MAX_NODES."
and another warning that happened with first increase to 100:
"warning: Included by graph for 'src.h' not generated, too many
nodes (111), threshold is 100. Consider increasing
DOT_GRAPH_MAX_NODES."
Signed-off-by: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>
@singalsu
singalsuforce-pushed the doxygen_address_too_many_nodes branch from 35bf79c to 1b2ded2CompareJuly 1, 2022 15:25
@marc-hb

Copy link
Copy Markdown
Collaborator

Not a big fan of this.

Can you share a screenshot of how a graph with ~ 100 nodes looks like? I'm afraid it won't be very useful - there must be a reason why the default is 50...

Another reason for this default: graph generation is by far the most time consuming part of doxygen. In fact it's often the ONLY time consuming part.

The alternative is to exclude generate code
https://www.doxygen.nl/manual/faq.html#faq_code How to exclude some code

Quoting a private chat from a certain @singalsu:

The file is computer generated and not interesting for document content.
...
But it needs to be added into the code generator too, so a bit more effort.

@singalsusingalsu changed the title Doxygen: Increase DOT_GRAPH_MAX_NODES to 100Doxygen: Increase DOT_GRAPH_MAX_NODES to 120Jul 1, 2022
@singalsu

singalsu commented Jul 1, 2022

Copy link
Copy Markdown
CollaboratorAuthor

@marc-hb Agree, I will try the other approach. It's OK if it doesn't suppress all src.h documentation, only the big rates matrix tables. The latter warning (see commit text) was from src.h that's not computer generated.

@marc-hb

Copy link
Copy Markdown
Collaborator

We run doxygen twice, the second time we add WARN_AS_ERROR = YES. This worked when I implemented this ages ago but now it merely prints and does not fail:

https://github.com/thesofproject/sof/runs/7138341491

@marc-hb

Copy link
Copy Markdown
Collaborator

This escape was a bug in doxygen, it has been fixed: https://github.com/thesofproject/sof/runs/7157109995

@marc-hb

marc-hb commented Jul 1, 2022

Copy link
Copy Markdown
Collaborator

doxygen upgrade (and fix) submitted in

Currently blocked by this warning.

@marc-hbmarc-hb left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found a simple way to exclude files in #5995 (and there are others)

EDIT: alternative to this PR added to #5979

@singalsu

Copy link
Copy Markdown
CollaboratorAuthor

I found a simple way to exclude files in #5995 (and there are others)

EDIT: alternative to this PR added to #5979

@marc-hb Thanks for the patches! I hope you didn't manually do the edits. I assume you didn't update SRC's Matlab generator script so I need to add those lines output there, right?

@singalsu

Copy link
Copy Markdown
CollaboratorAuthor

Marc's patches solve this issue, so this approach is not needed.

@marc-hb

Copy link
Copy Markdown
Collaborator

@marc-hb Thanks for the patches! I hope you didn't manually do the edits.

No, I wrote a very small script of course :-)

I assume you didn't update SRC's Matlab generator script so I need to add those lines output there, right?

Unfortunately not, sorry I'm not familiar enough with Matlab. See commit message of 31b1478:

Temporary, manual solution until the \cond directive is also generated
by the sof/tools/tune/src/export.m script(s)

Welcome back from vacation! Can you do this? :-)

@singalsu
singalsu deleted the doxygen_address_too_many_nodes branch September 15, 2022 13:17
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@singalsu@marc-hb