Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

coding_standard.md: Relax warning as error on release (opensource) #2

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

coding_standard.md: Relax warning as error on release (opensource) #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions coding_standard.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,13 @@ Use the compiler option -Werror to treat warnings as errors. This applies to bui

Exceptions to Werror have to be approved by the module owner and have their rationale documented. Exceptions should disable errors, but leave warnings intact (-wno-error=some-kind-of-warning) unless the warning is so noisy as flood build output. In that case, it should be disabled entirely (-wno-some-kind-of-warning).

### 3.1.6 Relax warning as errors ONLY on TAGs (Recommended)

While previous chapter is worth respecting, there is an exception that may be considered.
To improve adoption of the delivered software, maintainers should take into account that soon or later the user may have a stricter configuration (eg: toolchain change)
that would trigger new errors that were not trapped during the development phase, this could be blocking or at best just annoying.
Practically release manager just need commit a change that remove -Werror before tagging a release, and revert that commit just after to minimize that window.

## 3.2 Preprocessor ##

### 3.2.1 Use header file guards (Required) ###
Expand Down