threads / patch / 25533

patchCodingGuidelines: add a note to help contributors catch some errors earlier.

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

## tl;dr

3 messages between Oct 23, 2010 and Oct 23, 2010. Diffs are folded; open one to read it.

replies: 2people: 3as markdown or json

Yann Dirson· Oct 23, 2010, 14:17 UTC · lore

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 <ydirson@altern.org>
---
 Documentation/CodingGuidelines |    5 +++++
 1 files changed, 5 insertions(+), 0 deletions(-)

Show changes to Documentation/CodingGuidelines +5 −0

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

Thiago Farina· Oct 23, 2010, 17:11 UTC · re: Yann Dirson · lore

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

On Sat, Oct 23, 2010 at 12:17 PM, Yann Dirson <ydirson@altern.org> 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.

Yann Dirson· Oct 23, 2010, 18:48 UTC · re: Thiago Farina · lore

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

On Sat, Oct 23, 2010 at 03:11:19PM -0200, Thiago Farina wrote:

Show 8 quoted lines

> On Sat, Oct 23, 2010 at 12:17 PM, Yann Dirson <ydirson@altern.org> 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.

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.