| Message ID | 20190220003113.20746-2-richardw.yang@linux.intel.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | CODING_STYLE: trivial update | expand |
On 2/19/19 6:31 PM, Wei Yang wrote: > We didn't specify the indent rule for multiline code here, which may > misleading users. And in current code, the code use different rules. s/misleading/mislead/ > > Add this rule in CODING_STYLE to make sure this is clear to every one. > > Signed-off-by: Wei Yang <richardw.yang@linux.intel.com> > Suggested-by: Igor Mammedov <imammedo@redhat.com> > > --- > v2: > * rephrase changelog suggested by Eric Blake > - remove one redundant line > - fix some awkward grammar > - add { ; at the end of example > --- > CODING_STYLE | 23 +++++++++++++++++++++++ > 1 file changed, 23 insertions(+) > + > + do_something(arg1, arg2 > + arg3); Missing a comma after arg2. With that fixed, Reviewed-by: Eric Blake <eblake@redhat.com>
On Tue, Feb 19, 2019 at 09:02:34PM -0600, Eric Blake wrote: >On 2/19/19 6:31 PM, Wei Yang wrote: >> We didn't specify the indent rule for multiline code here, which may >> misleading users. And in current code, the code use different rules. > >s/misleading/mislead/ > >> >> Add this rule in CODING_STYLE to make sure this is clear to every one. >> >> Signed-off-by: Wei Yang <richardw.yang@linux.intel.com> >> Suggested-by: Igor Mammedov <imammedo@redhat.com> >> >> --- >> v2: >> * rephrase changelog suggested by Eric Blake >> - remove one redundant line >> - fix some awkward grammar >> - add { ; at the end of example >> --- >> CODING_STYLE | 23 +++++++++++++++++++++++ >> 1 file changed, 23 insertions(+) > >> + >> + do_something(arg1, arg2 >> + arg3); > >Missing a comma after arg2. With that fixed, >Reviewed-by: Eric Blake <eblake@redhat.com> You are right. > >-- >Eric Blake, Principal Software Engineer >Red Hat, Inc. +1-919-301-3226 >Virtualization: qemu.org | libvirt.org
diff --git a/CODING_STYLE b/CODING_STYLE index ec075dedc4..403904667a 100644 --- a/CODING_STYLE +++ b/CODING_STYLE @@ -29,6 +29,29 @@ Spaces of course are superior to tabs because: Do not leave whitespace dangling off the ends of lines. +1.1 Multiline Indent + +There are several places where indent is necessary: + + - struct definition + - if/else + - while/for + - function definition & call + +When breaking up a long line to fit within line widths, align the secondary +lines just after the opening parenthesis of the first. + +For example: + + if (a == 1 && + b == 2) { + + while (a == 1 && + b == 2) { + + do_something(arg1, arg2 + arg3); + 2. Line width Lines should be 80 characters; try not to make them longer.
We didn't specify the indent rule for multiline code here, which may misleading users. And in current code, the code use different rules. Add this rule in CODING_STYLE to make sure this is clear to every one. Signed-off-by: Wei Yang <richardw.yang@linux.intel.com> Suggested-by: Igor Mammedov <imammedo@redhat.com> --- v2: * rephrase changelog suggested by Eric Blake - remove one redundant line - fix some awkward grammar - add { ; at the end of example --- CODING_STYLE | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+)