-
Notifications
You must be signed in to change notification settings - Fork 2.1k
cppcheck: add rationale to suppressed warnings #1895
Copy link
Copy link
Closed
Labels
Area: docArea: DocumentationArea: DocumentationCommunity: good first issueThis issue is good for newcomers to RIOT to be addressed / implementedThis issue is good for newcomers to RIOT to be addressed / implementedType: cleanupThe issue proposes a clean-up / The PR cleans-up parts of the codebase / documentationThe issue proposes a clean-up / The PR cleans-up parts of the codebase / documentationType: enhancementThe issue suggests enhanceable parts / The PR enhances parts of the codebase / documentationThe issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation
Description
All suppressions for warnings/errors in cppcheck should be annotated with a rationale why the warning/error is suppressed instead of being fixed.
Also it would make sense to add a statement about this to the coding conventions in the wiki, if there is consent about this.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
Area: docArea: DocumentationArea: DocumentationCommunity: good first issueThis issue is good for newcomers to RIOT to be addressed / implementedThis issue is good for newcomers to RIOT to be addressed / implementedType: cleanupThe issue proposes a clean-up / The PR cleans-up parts of the codebase / documentationThe issue proposes a clean-up / The PR cleans-up parts of the codebase / documentationType: enhancementThe issue suggests enhanceable parts / The PR enhances parts of the codebase / documentationThe issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation