Skip to content

Conversation

@marc-hb
Copy link
Collaborator

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

From time to time sof-docs regressions are introduced in sof.git. This
introduces a random and sometimes long delay between when the regression
is introduced and when it is found. A recent example is
#5731 (comment)
where the doxygen comments were duplicated. Doxygen alone did not mind,
then the sof-docs build failed much later which took multiple people a
lot of time to understand and bisect.

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

From time to time sof-docs regressions are introduced in sof.git. This
introduces a random and sometimes long delay between when the regression
is introduced and when it is found. A recent example is
thesofproject#5731 (comment)
where the doxygen comments were duplicated. Doxygen alone did not mind,
then the sof-docs build failed much later which took multiple people a
lot of time to understand and bisect.

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
@marc-hb marc-hb marked this pull request as ready for review July 6, 2022 18:57
@marc-hb
Copy link
Collaborator Author

marc-hb commented Jul 6, 2022

The build in https://github.com/thesofproject/sof/runs/7220985472 failed as expected because of the doxygen duplication introduced by #5731 (comment). Catching this is exactly the purpose of this new check.

Waiting for @juimonen to remove that doxygen duplication.

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

Copy link

@intelkevinputnam intelkevinputnam left a comment

Choose a reason for hiding this comment

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

LGTM - Looks like the check is blocking itself. :-)

Copy link

@deb-intel deb-intel left a comment

Choose a reason for hiding this comment

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

Thanks, Marc!

Copy link
Member

@lgirdwood lgirdwood left a comment

Choose a reason for hiding this comment

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

Good work @marc-hb !

@lgirdwood lgirdwood merged commit 4d03c26 into thesofproject:main Jul 6, 2022
@marc-hb marc-hb deleted the add-sof-docs branch July 6, 2022 21:36
@marc-hb
Copy link
Collaborator Author

marc-hb commented Jul 6, 2022

Waiting for @juimonen to remove that doxygen duplication.

Just learned @juimonen is on vacation. 2-lines fix/workaround submitted at:

This simply excludes dai-legacy.h from doxygen instead of randomly mixing both; good enough for now.

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.

4 participants