From: Wei Yang <richardw.yang@linux.intel.com>
To: qemu-devel@nongnu.org, qemu-trivial@nongnu.org
Cc: mjt@tls.msk.ru, imammedo@redhat.com, philmd@redhat.com,
eblake@redhat.com, peter.maydell@linaro.org,
Wei Yang <richardw.yang@linux.intel.com>
Subject: [Qemu-devel] [PATCH v3 1/2] CODING_STYLE: specify the indent rule for multiline code
Date: Wed, 20 Feb 2019 11:15:56 +0800 [thread overview]
Message-ID: <20190220031557.26293-2-richardw.yang@linux.intel.com> (raw)
In-Reply-To: <20190220031557.26293-1-richardw.yang@linux.intel.com>
We didn't specify the indent rule for multiline code here, which may
mislead 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>
Reviewed-by: Eric Blake <eblake@redhat.com>
---
v3:
* misleading -> mislead
* add comma after arg2 in example
v2:
* rephrase changelog suggested by Eric Blake
- remove one redundant line
- fix some awkward grammar
- add { ; at the end of example
c1
---
CODING_STYLE | 23 +++++++++++++++++++++++
1 file changed, 23 insertions(+)
diff --git a/CODING_STYLE b/CODING_STYLE
index ec075dedc4..1359f9ab81 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.
--
2.19.1
next prev parent reply other threads:[~2019-02-20 3:16 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-02-20 3:15 [Qemu-devel] [PATCH v3 0/2] CODING_STYLE: trivial update Wei Yang
2019-02-20 3:15 ` Wei Yang [this message]
2019-02-21 14:55 ` [Qemu-devel] [PATCH v3 1/2] CODING_STYLE: specify the indent rule for multiline code Igor Mammedov
2019-02-23 0:04 ` Wei Yang
2019-02-20 3:15 ` [Qemu-devel] [PATCH v3 2/2] CODING_STYLE: indent example code as all others Wei Yang
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190220031557.26293-2-richardw.yang@linux.intel.com \
--to=richardw.yang@linux.intel.com \
--cc=eblake@redhat.com \
--cc=imammedo@redhat.com \
--cc=mjt@tls.msk.ru \
--cc=peter.maydell@linaro.org \
--cc=philmd@redhat.com \
--cc=qemu-devel@nongnu.org \
--cc=qemu-trivial@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).