From patchwork Mon Feb 25 01:25:29 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Wei Yang X-Patchwork-Id: 1047552 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (mailfrom) smtp.mailfrom=nongnu.org (client-ip=209.51.188.17; helo=lists.gnu.org; envelope-from=qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org; receiver=) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=linux.intel.com Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 4474724nRJz9sB3 for ; Mon, 25 Feb 2019 12:27:07 +1100 (AEDT) Received: from localhost ([127.0.0.1]:58336 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gy52t-0008Cj-Ur for incoming@patchwork.ozlabs.org; Sun, 24 Feb 2019 20:27:04 -0500 Received: from eggs.gnu.org ([209.51.188.92]:53195) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gy51w-0008BE-CB for qemu-devel@nongnu.org; Sun, 24 Feb 2019 20:26:05 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gy51v-0006Pi-FO for qemu-devel@nongnu.org; Sun, 24 Feb 2019 20:26:04 -0500 Received: from mga02.intel.com ([134.134.136.20]:17645) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1gy51v-0006PA-1R; Sun, 24 Feb 2019 20:26:03 -0500 X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by orsmga101.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 24 Feb 2019 17:26:01 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.58,409,1544515200"; d="scan'208";a="146205282" Received: from richard.sh.intel.com (HELO localhost) ([10.239.159.54]) by fmsmga002.fm.intel.com with ESMTP; 24 Feb 2019 17:26:00 -0800 From: Wei Yang To: qemu-devel@nongnu.org, qemu-trivial@nongnu.org Date: Mon, 25 Feb 2019 09:25:29 +0800 Message-Id: <20190225012530.28225-2-richardw.yang@linux.intel.com> X-Mailer: git-send-email 2.19.1 In-Reply-To: <20190225012530.28225-1-richardw.yang@linux.intel.com> References: <20190225012530.28225-1-richardw.yang@linux.intel.com> MIME-Version: 1.0 X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 134.134.136.20 Subject: [Qemu-devel] [PATCH v4 1/2] CODING_STYLE: specify the indent rule for multiline code X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: peter.maydell@linaro.org, philmd@redhat.com, mjt@tls.msk.ru, Wei Yang , imammedo@redhat.com Errors-To: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Sender: "Qemu-devel" 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 Suggested-by: Igor Mammedov --- v4: * widths -> width * add an exception example for function 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 --- CODING_STYLE | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/CODING_STYLE b/CODING_STYLE index ec075dedc4..1bccf4f865 100644 --- a/CODING_STYLE +++ b/CODING_STYLE @@ -29,6 +29,35 @@ 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 width, 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); + +One exception for function is indenting following lines relative to function +name start: + + do_something(arg1, arg2, + arg3); + 2. Line width Lines should be 80 characters; try not to make them longer. From patchwork Mon Feb 25 01:25:30 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Wei Yang X-Patchwork-Id: 1047554 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (mailfrom) smtp.mailfrom=nongnu.org (client-ip=209.51.188.17; helo=lists.gnu.org; envelope-from=qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org; receiver=) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=linux.intel.com Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 44747975dYz9s9y for ; Mon, 25 Feb 2019 12:27:17 +1100 (AEDT) Received: from localhost ([127.0.0.1]:58342 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gy535-0008NV-Pu for incoming@patchwork.ozlabs.org; Sun, 24 Feb 2019 20:27:15 -0500 Received: from eggs.gnu.org ([209.51.188.92]:53226) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gy51x-0008Bq-S5 for qemu-devel@nongnu.org; Sun, 24 Feb 2019 20:26:06 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gy51x-0006Qg-5h for qemu-devel@nongnu.org; Sun, 24 Feb 2019 20:26:05 -0500 Received: from mga02.intel.com ([134.134.136.20]:17645) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1gy51w-0006PA-TT; Sun, 24 Feb 2019 20:26:05 -0500 X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by orsmga101.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 24 Feb 2019 17:26:04 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.58,409,1544515200"; d="scan'208";a="146205292" Received: from richard.sh.intel.com (HELO localhost) ([10.239.159.54]) by fmsmga002.fm.intel.com with ESMTP; 24 Feb 2019 17:26:02 -0800 From: Wei Yang To: qemu-devel@nongnu.org, qemu-trivial@nongnu.org Date: Mon, 25 Feb 2019 09:25:30 +0800 Message-Id: <20190225012530.28225-3-richardw.yang@linux.intel.com> X-Mailer: git-send-email 2.19.1 In-Reply-To: <20190225012530.28225-1-richardw.yang@linux.intel.com> References: <20190225012530.28225-1-richardw.yang@linux.intel.com> MIME-Version: 1.0 X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 134.134.136.20 Subject: [Qemu-devel] [PATCH v4 2/2] CODING_STYLE: indent example code as all others X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: peter.maydell@linaro.org, philmd@redhat.com, mjt@tls.msk.ru, Wei Yang , imammedo@redhat.com Errors-To: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Sender: "Qemu-devel" All the example code are indented with four spaces except this one. Fix this by adding four spaces here. Signed-off-by: Wei Yang Reviewed-by: Eric Blake Reviewed-by: Philippe Mathieu-Daudé Reviewed-by: Igor Mammedov --- CODING_STYLE | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CODING_STYLE b/CODING_STYLE index 1bccf4f865..e6d21dcd67 100644 --- a/CODING_STYLE +++ b/CODING_STYLE @@ -137,10 +137,10 @@ block to a separate function altogether. When comparing a variable for (in)equality with a constant, list the constant on the right, as in: -if (a == 1) { - /* Reads like: "If a equals 1" */ - do_something(); -} + if (a == 1) { + /* Reads like: "If a equals 1" */ + do_something(); + } Rationale: Yoda conditions (as in 'if (1 == a)') are awkward to read. Besides, good compilers already warn users when '==' is mis-typed as '=',