From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([209.51.188.92]:41834) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gwDax-0000V5-Lk for qemu-devel@nongnu.org; Tue, 19 Feb 2019 17:10:32 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gwDV0-0002uC-CS for qemu-devel@nongnu.org; Tue, 19 Feb 2019 17:04:24 -0500 Date: Tue, 19 Feb 2019 22:04:18 +0000 From: Wei Yang Message-ID: <20190219220418.qle4kfetwcdagr4q@master> Reply-To: Wei Yang References: <20190219013106.17538-1-richardw.yang@linux.intel.com> <20190219013106.17538-2-richardw.yang@linux.intel.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: Subject: Re: [Qemu-devel] [PATCH 1/2] CODING_STYLE: specify the indent rule for multiline code List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Eric Blake Cc: Wei Yang , qemu-devel@nongnu.org, qemu-trivial@nongnu.org, imammedo@redhat.com, mjt@tls.msk.ru On Tue, Feb 19, 2019 at 11:52:29AM -0600, Eric Blake wrote: >On 2/18/19 7: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. >> >> Add this rule in CODING_STYLE to make sure this is clear to every one. >> >> Signed-off-by: Wei Yang >> Suggested-by: Igor Mammedov >> --- >> CODING_STYLE | 26 ++++++++++++++++++++++++++ >> 1 file changed, 26 insertions(+) >> >> diff --git a/CODING_STYLE b/CODING_STYLE >> index ec075dedc4..73f66ca185 100644 >> --- a/CODING_STYLE >> +++ b/CODING_STYLE >> @@ -29,6 +29,32 @@ 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 >> + >> +All the above cases apply the same rule: indent with four spaces. > >Is this redundant with the earlier statement that "QEMU indents are four >spaces."? > >> + >> +While the last three case may face another situation: code should spread into >> +several lines. In this case the rule is align the new line with first >> +parentheses. > >Grammar is awkward - the leading 'while' makes it sound like that you >have a dependent clause, but then never provide the independent clause. >Maybe a completely different wording is better: > >When breaking up a long line to fit within line widths, align the >secondary lines just after the opening parenthesis of the first. > Sounds better. >> + >> +For example: >> + >> + if (a == 1 && >> + b == 2) >> + > >Maybe: > >if (a == 1 && > b == 2) { > >to match our later recommendations on always using {}. > Yep. >> + while (a == 1 && >> + b == 2) >> + > >Similar. > >> + do_something(arg1, arg2 >> + arg3) >> + > >and here, I'd include the ';' to make it a valid statement. > Reasonable. >> 2. Line width >> >> Lines should be 80 characters; try not to make them longer. >> > >-- >Eric Blake, Principal Software Engineer >Red Hat, Inc. +1-919-301-3226 >Virtualization: qemu.org | libvirt.org -- Wei Yang Help you, Help me