All of lore.kernel.org
 help / color / mirror / Atom feed
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,
	Wei Yang <richardw.yang@linux.intel.com>
Subject: [Qemu-trivial] [PATCH 1/2] CODING_STYLE: specify the indent rule for multiline code
Date: Tue, 19 Feb 2019 09:31:05 +0800	[thread overview]
Message-ID: <20190219013106.17538-2-richardw.yang@linux.intel.com> (raw)
In-Reply-To: <20190219013106.17538-1-richardw.yang@linux.intel.com>

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>
---
 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.
+
+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.
+
+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



WARNING: multiple messages have this Message-ID (diff)
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,
	Wei Yang <richardw.yang@linux.intel.com>
Subject: [Qemu-devel] [PATCH 1/2] CODING_STYLE: specify the indent rule for multiline code
Date: Tue, 19 Feb 2019 09:31:05 +0800	[thread overview]
Message-ID: <20190219013106.17538-2-richardw.yang@linux.intel.com> (raw)
In-Reply-To: <20190219013106.17538-1-richardw.yang@linux.intel.com>

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>
---
 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.
+
+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.
+
+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

  reply	other threads:[~2019-02-19  1:31 UTC|newest]

Thread overview: 30+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-02-19  1:31 [Qemu-trivial] [PATCH 0/2] CODING_STYLE: trivial update Wei Yang
2019-02-19  1:31 ` [Qemu-devel] " Wei Yang
2019-02-19  1:31 ` Wei Yang [this message]
2019-02-19  1:31   ` [Qemu-devel] [PATCH 1/2] CODING_STYLE: specify the indent rule for multiline code Wei Yang
2019-02-19 17:34   ` [Qemu-trivial] " Philippe Mathieu-Daudé
2019-02-19 17:34     ` Philippe Mathieu-Daudé
2019-02-19 17:55     ` [Qemu-trivial] " Eric Blake
2019-02-19 17:55       ` Eric Blake
2019-02-19 22:03       ` [Qemu-trivial] " Wei Yang
2019-02-19 22:03         ` Wei Yang
2019-02-19 17:52   ` [Qemu-trivial] " Eric Blake
2019-02-19 17:52     ` Eric Blake
2019-02-19 22:04     ` [Qemu-trivial] " Wei Yang
2019-02-19 22:04       ` Wei Yang
2019-02-19  1:31 ` [Qemu-trivial] [PATCH 2/2] CODING_STYLE: indent example code as all others Wei Yang
2019-02-19  1:31   ` [Qemu-devel] " Wei Yang
2019-02-19 17:38   ` [Qemu-trivial] " Philippe Mathieu-Daudé
2019-02-19 17:38     ` Philippe Mathieu-Daudé
2019-02-19 17:56     ` [Qemu-trivial] " Eric Blake
2019-02-19 17:56       ` Eric Blake
2019-02-19 18:55       ` [Qemu-trivial] " Philippe Mathieu-Daudé
2019-02-19 18:55         ` Philippe Mathieu-Daudé
2019-02-19 22:20         ` [Qemu-trivial] " Wei Yang
2019-02-19 22:20           ` Wei Yang
2019-02-19 23:55           ` [Qemu-trivial] " Philippe Mathieu-Daudé
2019-02-19 23:55             ` Philippe Mathieu-Daudé
2019-02-19 22:05     ` [Qemu-trivial] " Wei Yang
2019-02-19 22:05       ` Wei Yang
2019-02-19 17:57   ` [Qemu-trivial] " Eric Blake
2019-02-19 17:57     ` Eric Blake

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=20190219013106.17538-2-richardw.yang@linux.intel.com \
    --to=richardw.yang@linux.intel.com \
    --cc=imammedo@redhat.com \
    --cc=mjt@tls.msk.ru \
    --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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.