Skip to content

Conversation

@marc-hb
Copy link
Collaborator

@marc-hb marc-hb commented Jul 1, 2022

This upgrades doxygen from version 1.8.17 to 1.9.1

This provides FAIL_ON_WARNINGS and fixes issues like
doxygen/doxygen#7970

Signed-off-by: Marc Herbert marc.herbert@intel.com

This should upgrade doxygen from version 1.8.17 to 1.9.1

This will hopefully provide FAIL_ON_WARNINGS and fix issues like
doxygen/doxygen#7970

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
@marc-hb marc-hb requested a review from singalsu July 1, 2022 21:49
@marc-hb
Copy link
Collaborator Author

marc-hb commented Jul 1, 2022

https://github.com/thesofproject/sof/runs/7157184365 fails with:

warning: Include graph for 'src_ipc4_int32_table.h' not generated, too many nodes (89), threshold is 50. Consider increasing DOT_GRAPH_MAX_NODES.
warning: Included by graph for 'src.h' not generated, too many nodes, threshold is 50. Consider increasing DOT_GRAPH_MAX_NODES.

This warning was escaping WARN_AS_ERROR because of doxygen 1.8.17 bug. It was printed but not changing the exist status. doxygen 1.9.1 in Ubuntu 22 does not miss it.

So this PR is blocked until this warning is fixed, @singalsu is working on the warning.

Unlike the older 'YES', FAIL_ON_WARNINGS reports all warnings.

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
marc-hb added 2 commits July 6, 2022 16:13
Fixes doxygen warning:

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

This code is generated and pollutes doxygen output anyway.

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

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
Fixes doxygen warning:

warning: Included by graph for 'src.h' not generated, too many
nodes (111), threshold is 50. Consider increasing DOT_GRAPH_MAX_NODES.

This code is generated and pollutes doxygen output anyway.

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

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
@marc-hb
Copy link
Collaborator Author

marc-hb commented Jul 6, 2022

@singalsu is on vacation so went ahead and I manually added \cond doxygen directives in about 90 files, which successfully fixes the two DOT_GRAPH_MAX_NODES above. See new commit messages.

This fixes the doxygen build in https://github.com/thesofproject/sof/runs/7224393035, even with Ubuntu 22.04


The fix for the other, unrelated warnings in the new "sof-docs" build below has been submitted in

Warning: Duplicate target detected: group__sof__dai__drivers_1ga8c720c310f408b2f97ce014562d6a910
/home/runner/work/sof/sof/sof-docs/api/dai-drivers-api.rst:4: WARNING: Duplicate ID: "group__sof__dai__drivers_1ga8c720c310f408b2f97ce014562d6a910".
/home/runner/work/sof/sof/sof-docs/api/dai-drivers-api.rst:4: WARNING: Duplicate explicit target name: "group__sof__dai__drivers_1ga8c720c310f408b2f97ce014562d6a910".
/home/runner/work/sof/sof/sof-docs/api/dai-drivers-api.rst:6: WARNING: Duplicate declaration, const struct device* dai::drv

@lgirdwood lgirdwood merged commit 31b1478 into thesofproject:main Jul 7, 2022
@marc-hb marc-hb deleted the doxygen-ub22 branch August 31, 2022 14:50
Sign up for free to 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