[PATCH] CodingGuidelines: add a note to help contributors catch some errors earlier.

Subsystems: documentation, the rest

DORMANTno replies

3 messages, 3 authors, 2016-06-15 · open the first message on its own page

[PATCH] CodingGuidelines: add a note to help contributors catch some errors earlier.

From: Yann Dirson <hidden>
Date: 2016-06-15 22:49:51

It is a bit of a shame to wait for other's review before noticing
decl-after-stmt situations, whereas a quick check could have found it.
There are probably a number of other autoamted checks which could be
described here, but that's a start.

Signed-off-by: Yann Dirson <redacted>
---
 Documentation/CodingGuidelines |    5 +++++
 1 files changed, 5 insertions(+), 0 deletions(-)
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index 09ffc46..7ecd4f3 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -139,3 +139,8 @@ For C programs:
 
  - When we pass <string, length> pair to functions, we should try to
    pass them in that order.
+
+ - C code is expected to compile when the build is launched with the
+   following command:
+
+   make CFLAGS="-Wall -Wdeclaration-after-statement -Werror"
-- 
1.7.2.3

Re: [PATCH] CodingGuidelines: add a note to help contributors catch some errors earlier.

From: Thiago Farina <hidden>
Date: 2016-06-15 22:49:51

On Sat, Oct 23, 2010 at 12:17 PM, Yann Dirson [off-list ref] wrote:
+ - C code is expected to compile when the build is launched with the
+   following command:
+
+   make CFLAGS="-Wall -Wdeclaration-after-statement -Werror"
Why this is not in the Makefile by default? Also -Wall is already in
the Makefile.

Re: [PATCH] CodingGuidelines: add a note to help contributors catch some errors earlier.

From: Yann Dirson <hidden>
Date: 2016-06-15 22:49:51

On Sat, Oct 23, 2010 at 03:11:19PM -0200, Thiago Farina wrote:
On Sat, Oct 23, 2010 at 12:17 PM, Yann Dirson [off-list ref] wrote:
quoted
+ - C code is expected to compile when the build is launched with the
+   following command:
+
+   make CFLAGS="-Wall -Wdeclaration-after-statement -Werror"
Why this is not in the Makefile by default? Also -Wall is already in
the Makefile.
CFLAGS seems to be used for more than gcc, and -Wall seems to be
portable enough to be overriden only in a couple of cases.  It would
not be the same for those flags.

Also note that -Wdeclaration-after-statement is also mentionned in
SubmittingPatches, but I still think it is a better place in
CodingGuidelines, which contributers are most likely to use as a
checklist before publishing.
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help