From 490d57101c7625101ebb1011ac8e7515d4ff8ef9 Mon Sep 17 00:00:00 2001 From: Philippe Coval Date: Mon, 17 Feb 2025 11:26:23 +0100 Subject: [PATCH] coding_standard.md: Relax warning as error on release (opensource) This is a "user oriented" best practice used in many FLOSS projects. Fixing at least one supported env is good, but maybe not enough, extending support can help but will it scale? Reality of sofware engineering is that software integration is a moving science, constraints are evolving over space and time. We can't anticipate (future) breakage, this change can mitigate the annoyance and maximize user adoption, help integrators and ease software maintenance. The alternative option, would be to wait user(s) to complain and provide support for the desired env in an acceptable time frame. Signed-off-by: Philippe Coval --- coding_standard.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/coding_standard.md b/coding_standard.md index 3fe9fcd..3fdb2c2 100644 --- a/coding_standard.md +++ b/coding_standard.md @@ -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) ###