[SKIP SOFCI-TEST] doc: doxygen: do not fail on warnings#10338
[SKIP SOFCI-TEST] doc: doxygen: do not fail on warnings#10338lgirdwood merged 1 commit intothesofproject:mainfrom
Conversation
We have had sof-docs CI builds failing due to warnings that have not been addressed for more than 3 months. Limit the check to fatal errors to resume at least a barebones level of check for doxygen build target in the CI. Signed-off-by: Kai Vehmanen <kai.vehmanen@linux.intel.com>
kv2019i
force-pushed
the
202510-ci-relax-doxygen
branch
from
80c9652 to
65ebdc1
Compare
kv2019i
requested review from
dbaluta,
lbetlej,
lgirdwood,
mmaka1 and
plbossart
as code owners
There was a problem hiding this comment.
Pull Request Overview
This PR modifies the documentation build process to prevent CI failures caused by Doxygen warnings. The change shifts from treating warnings as errors to only failing on fatal errors, allowing the CI to continue providing basic validation while known warnings remain unaddressed.
- Disables
WARN_AS_ERRORin the Doxygen configuration - Adds
LAX=1flag to the documentation build command in CI workflow
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| doc/sof.doxygen.in | Disables treating warnings as errors in Doxygen configuration |
| .github/workflows/sof-docs.yml | Enables lax mode for the documentation build process |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| #FILTER_SOURCE_FILES = YES | ||
|
|
||
| HTML_TIMESTAMP = NO | ||
| WARN_AS_ERROR = NO |
There was a problem hiding this comment.
[nitpick] Setting WARN_AS_ERROR = NO creates technical debt by allowing documentation warnings to accumulate. Consider creating a tracking issue to address the existing warnings and restore this setting to YES, or implement a gradual improvement plan to prevent new warnings while cleaning up existing ones.
| WARN_AS_ERROR = NO | |
| WARN_AS_ERROR = YES |
4 participants
We have had sof-docs CI builds failing due to warnings that have not been addressed for more than 3 months. Limit the check to fatal errors to resume at least a barebones level of check for doxygen build target in the CI.