Re: [Qemu-devel] [PATCH] CODING_STYLE: Mention preferred comment form
03.02.2017 20:58, Peter Maydell wrote: > Our defacto coding style strongly prefers /* */ style comments > over the single-line // style, and checkpatch enforces this, > but we don't actually document this. Mention it in CODING_STYLE. Applied to -trivial, thanks! /mjt
Re: [Qemu-devel] [PATCH] CODING_STYLE: Mention preferred comment form
On Fri, Feb 03, 2017 at 05:58:42PM +, Peter Maydell wrote: > Our defacto coding style strongly prefers /* */ style comments > over the single-line // style, and checkpatch enforces this, > but we don't actually document this. Mention it in CODING_STYLE. > > Suggested-by: Thomas Huth> Signed-off-by: Peter Maydell > --- > CODING_STYLE | 7 +++ > 1 file changed, 7 insertions(+) Reviewed-by: Stefan Hajnoczi signature.asc Description: PGP signature
Re: [Qemu-devel] [PATCH] CODING_STYLE: Mention preferred comment form
On Fri, 02/03 17:58, Peter Maydell wrote: > Our defacto coding style strongly prefers /* */ style comments > over the single-line // style, and checkpatch enforces this, > but we don't actually document this. Mention it in CODING_STYLE. > > Suggested-by: Thomas Huth> Signed-off-by: Peter Maydell > --- > CODING_STYLE | 7 +++ > 1 file changed, 7 insertions(+) > > diff --git a/CODING_STYLE b/CODING_STYLE > index f53180b..2fa0c0b 100644 > --- a/CODING_STYLE > +++ b/CODING_STYLE > @@ -116,3 +116,10 @@ if (a == 1) { > Rationale: Yoda conditions (as in 'if (1 == a)') are awkward to read. > Besides, good compilers already warn users when '==' is mis-typed as '=', > even when the constant is on the right. > + > +7. Comment style > + > +We use traditional C-style /* */ comments and avoid // comments. > + > +Rationale: The // form is valid in C99, so this is purely a matter of > +consistency of style. The checkpatch script will warn you about this. Reviewed-by: Fam Zheng
Re: [Qemu-devel] [PATCH] CODING_STYLE: Mention preferred comment form
Peter Maydellwrites: > Our defacto coding style strongly prefers /* */ style comments > over the single-line // style, and checkpatch enforces this, > but we don't actually document this. Mention it in CODING_STYLE. > > Suggested-by: Thomas Huth > Signed-off-by: Peter Maydell > --- > CODING_STYLE | 7 +++ > 1 file changed, 7 insertions(+) > > diff --git a/CODING_STYLE b/CODING_STYLE > index f53180b..2fa0c0b 100644 > --- a/CODING_STYLE > +++ b/CODING_STYLE > @@ -116,3 +116,10 @@ if (a == 1) { > Rationale: Yoda conditions (as in 'if (1 == a)') are awkward to read. > Besides, good compilers already warn users when '==' is mis-typed as '=', > even when the constant is on the right. > + > +7. Comment style > + > +We use traditional C-style /* */ comments and avoid // comments. > + > +Rationale: The // form is valid in C99, so this is purely a matter of > +consistency of style. The checkpatch script will warn you about this. Reviewed-by: Markus Armbruster
[Qemu-devel] [PATCH] CODING_STYLE: Mention preferred comment form
Our defacto coding style strongly prefers /* */ style comments over the single-line // style, and checkpatch enforces this, but we don't actually document this. Mention it in CODING_STYLE. Suggested-by: Thomas HuthSigned-off-by: Peter Maydell --- CODING_STYLE | 7 +++ 1 file changed, 7 insertions(+) diff --git a/CODING_STYLE b/CODING_STYLE index f53180b..2fa0c0b 100644 --- a/CODING_STYLE +++ b/CODING_STYLE @@ -116,3 +116,10 @@ if (a == 1) { Rationale: Yoda conditions (as in 'if (1 == a)') are awkward to read. Besides, good compilers already warn users when '==' is mis-typed as '=', even when the constant is on the right. + +7. Comment style + +We use traditional C-style /* */ comments and avoid // comments. + +Rationale: The // form is valid in C99, so this is purely a matter of +consistency of style. The checkpatch script will warn you about this. -- 2.7.4