Skip to content

Conversation

@marc-hb
Copy link
Collaborator

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

This fixes the sof-docs build and stops producing a dai-drivers-api.html
garbage that randomly mixed the two .h files.

Warning: Duplicate target detected:
    group__sof__dai__drivers_1ga8c720c310f408b2f97ce014562d6a910
sof-docs/api/dai-drivers-api.rst:4: WARNING: Duplicate ID:
   "group__sof__dai__drivers_1ga8c720c310f408b2f97ce014562d6a910".
sof-docs/api/dai-drivers-api.rst:4: WARNING: Duplicate explicit target name:
   "group__sof__dai__drivers_1ga8c720c310f408b2f97ce014562d6a910".

sof/sof-docs/api/dai-drivers-api.rst:6: WARNING:
  Duplicate declaration, const struct device* dai::drv

(Temporarily?) fixes commit 015ec63 ("zephyr: add glue code to
use zephyr dai drivers") that introduced a lot of duplication with
dai-zephyr.h. See more details at
#5731 (comment)

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

This fixes the sof-docs build and stops producing a dai-drivers-api.html
garbage that randomly mixed the two .h files.

```
Warning: Duplicate target detected:
    group__sof__dai__drivers_1ga8c720c310f408b2f97ce014562d6a910
sof-docs/api/dai-drivers-api.rst:4: WARNING: Duplicate ID:
   "group__sof__dai__drivers_1ga8c720c310f408b2f97ce014562d6a910".
sof-docs/api/dai-drivers-api.rst:4: WARNING: Duplicate explicit target name:
   "group__sof__dai__drivers_1ga8c720c310f408b2f97ce014562d6a910".

sof/sof-docs/api/dai-drivers-api.rst:6: WARNING:
  Duplicate declaration, const struct device* dai::drv
```

(Temporarily?) fixes commit 015ec63 ("zephyr: add glue code to
use zephyr dai drivers") that introduced a lot of duplication with
dai-zephyr.h. See more details at
thesofproject#5731 (comment)

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
@marc-hb marc-hb changed the title Exclude dai-legacy.h from doxygen to avoid clashes with dai-zephyr.h [SKIP CI] Exclude dai-legacy.h from doxygen to avoid clashes with dai-zephyr.h Jul 6, 2022
@marc-hb marc-hb marked this pull request as ready for review July 6, 2022 22:00
@marc-hb
Copy link
Collaborator Author

marc-hb commented Jul 6, 2022

If you feel generous, please also review the very similar (but unrelated) #5979

@marc-hb marc-hb requested a review from wszypelt July 6, 2022 23:50
@marc-hb
Copy link
Collaborator Author

marc-hb commented Jul 6, 2022

There's WHL-specific failure in https://sof-ci.01.org/sof-pr-viewer/#/build/PR5995/build9800959 so unrelated to this pure doxygen change.

@lgirdwood lgirdwood merged commit 7eb5ffc into thesofproject:main Jul 7, 2022
@marc-hb marc-hb deleted the exclude-dai-legacy-docs branch July 7, 2022 15:27
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