From patchwork Wed Feb 20 00:31:12 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Wei Yang X-Patchwork-Id: 10820935 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id B71556C2 for ; Wed, 20 Feb 2019 00:39:36 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 973752D3E2 for ; Wed, 20 Feb 2019 00:39:36 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 89B332D3E8; Wed, 20 Feb 2019 00:39:36 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-2.9 required=2.0 tests=BAYES_00,MAILING_LIST_MULTI autolearn=ham version=3.3.1 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id 33E222D3E2 for ; Wed, 20 Feb 2019 00:39:36 +0000 (UTC) Received: from localhost ([127.0.0.1]:57106 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gwFvD-0006Dc-HF for patchwork-qemu-devel@patchwork.kernel.org; Tue, 19 Feb 2019 19:39:35 -0500 Received: from eggs.gnu.org ([209.51.188.92]:37071) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gwFuc-0005e3-Sc for qemu-devel@nongnu.org; Tue, 19 Feb 2019 19:38:59 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gwFuG-0008C5-DE for qemu-devel@nongnu.org; Tue, 19 Feb 2019 19:38:50 -0500 Received: from mga01.intel.com ([192.55.52.88]:28230) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1gwFu1-0006ZL-5B; Tue, 19 Feb 2019 19:38:27 -0500 X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by fmsmga101.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 19 Feb 2019 16:32:19 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.58,388,1544515200"; d="scan'208";a="148209996" Received: from richard.sh.intel.com (HELO localhost) ([10.239.159.54]) by fmsmga001.fm.intel.com with ESMTP; 19 Feb 2019 16:32:18 -0800 From: Wei Yang To: qemu-devel@nongnu.org, qemu-trivial@nongnu.org Date: Wed, 20 Feb 2019 08:31:12 +0800 Message-Id: <20190220003113.20746-2-richardw.yang@linux.intel.com> X-Mailer: git-send-email 2.19.1 In-Reply-To: <20190220003113.20746-1-richardw.yang@linux.intel.com> References: <20190220003113.20746-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: 192.55.52.88 Subject: [Qemu-devel] [PATCH v2 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+patchwork-qemu-devel=patchwork.kernel.org@nongnu.org Sender: "Qemu-devel" X-Virus-Scanned: ClamAV using ClamSMTP 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 Reviewed-by: Eric Blake --- 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(+) 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. From patchwork Wed Feb 20 00:31:13 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Wei Yang X-Patchwork-Id: 10820931 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id D15176C2 for ; Wed, 20 Feb 2019 00:35:56 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id BD0072D073 for ; Wed, 20 Feb 2019 00:35:56 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id B0F122D3D5; Wed, 20 Feb 2019 00:35:56 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-2.9 required=2.0 tests=BAYES_00,MAILING_LIST_MULTI autolearn=ham version=3.3.1 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id 5DEFD2D37E for ; Wed, 20 Feb 2019 00:35:56 +0000 (UTC) Received: from localhost ([127.0.0.1]:57084 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gwFrd-0004Kv-4a for patchwork-qemu-devel@patchwork.kernel.org; Tue, 19 Feb 2019 19:35:53 -0500 Received: from eggs.gnu.org ([209.51.188.92]:36592) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gwFqY-0003aW-AL for qemu-devel@nongnu.org; Tue, 19 Feb 2019 19:34:46 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gwFqI-0007AU-DX for qemu-devel@nongnu.org; Tue, 19 Feb 2019 19:34:34 -0500 Received: from mga01.intel.com ([192.55.52.88]:28232) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1gwFq9-0006Zn-Hl; Tue, 19 Feb 2019 19:34:26 -0500 X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by fmsmga101.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 19 Feb 2019 16:32:21 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.58,388,1544515200"; d="scan'208";a="148209999" Received: from richard.sh.intel.com (HELO localhost) ([10.239.159.54]) by fmsmga001.fm.intel.com with ESMTP; 19 Feb 2019 16:32:20 -0800 From: Wei Yang To: qemu-devel@nongnu.org, qemu-trivial@nongnu.org Date: Wed, 20 Feb 2019 08:31:13 +0800 Message-Id: <20190220003113.20746-3-richardw.yang@linux.intel.com> X-Mailer: git-send-email 2.19.1 In-Reply-To: <20190220003113.20746-1-richardw.yang@linux.intel.com> References: <20190220003113.20746-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: 192.55.52.88 Subject: [Qemu-devel] [PATCH v2 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+patchwork-qemu-devel=patchwork.kernel.org@nongnu.org Sender: "Qemu-devel" X-Virus-Scanned: ClamAV using ClamSMTP 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é --- CODING_STYLE | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CODING_STYLE b/CODING_STYLE index 403904667a..5679b2fd69 100644 --- a/CODING_STYLE +++ b/CODING_STYLE @@ -131,10 +131,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 '=',