From nobody Sun May 5 16:12:38 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linux.intel.com Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1550539981994180.8220782557927; Mon, 18 Feb 2019 17:33:01 -0800 (PST) Received: from localhost ([127.0.0.1]:39520 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gvuHE-0007BL-0o for importer@patchew.org; Mon, 18 Feb 2019 20:32:52 -0500 Received: from eggs.gnu.org ([209.51.188.92]:36995) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gvuGB-0006pJ-SH for qemu-devel@nongnu.org; Mon, 18 Feb 2019 20:31:48 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gvuGB-00025n-3X for qemu-devel@nongnu.org; Mon, 18 Feb 2019 20:31:47 -0500 Received: from mga18.intel.com ([134.134.136.126]:14723) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1gvuGA-00023B-Qy; Mon, 18 Feb 2019 20:31:47 -0500 Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by orsmga106.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 18 Feb 2019 17:31:40 -0800 Received: from richard.sh.intel.com (HELO localhost) ([10.239.159.54]) by fmsmga006.fm.intel.com with ESMTP; 18 Feb 2019 17:31:38 -0800 X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.58,385,1544515200"; d="scan'208";a="320097212" From: Wei Yang To: qemu-devel@nongnu.org, qemu-trivial@nongnu.org Date: Tue, 19 Feb 2019 09:31:05 +0800 Message-Id: <20190219013106.17538-2-richardw.yang@linux.intel.com> X-Mailer: git-send-email 2.19.1 In-Reply-To: <20190219013106.17538-1-richardw.yang@linux.intel.com> References: <20190219013106.17538-1-richardw.yang@linux.intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 134.134.136.126 Subject: [Qemu-devel] [PATCH 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: imammedo@redhat.com, mjt@tls.msk.ru, Wei Yang Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" Content-Type: text/plain; charset="utf-8" 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: =20 Do not leave whitespace dangling off the ends of lines. =20 +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 i= nto +several lines. In this case the rule is align the new line with first +parentheses. + +For example: + + if (a =3D=3D 1 && + b =3D=3D 2) + + while (a =3D=3D 1 && + b =3D=3D 2) + + do_something(arg1, arg2 + arg3) + 2. Line width =20 Lines should be 80 characters; try not to make them longer. --=20 2.19.1 From nobody Sun May 5 16:12:38 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linux.intel.com Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1550540084573935.1509484684052; Mon, 18 Feb 2019 17:34:44 -0800 (PST) Received: from localhost ([127.0.0.1]:39535 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gvuIy-00088F-J3 for importer@patchew.org; Mon, 18 Feb 2019 20:34:40 -0500 Received: from eggs.gnu.org ([209.51.188.92]:37314) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gvuHI-0007JF-4o for qemu-devel@nongnu.org; Mon, 18 Feb 2019 20:32:56 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gvuHG-0002XV-QE for qemu-devel@nongnu.org; Mon, 18 Feb 2019 20:32:56 -0500 Received: from mga18.intel.com ([134.134.136.126]:14725) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1gvuH6-00024H-2E; Mon, 18 Feb 2019 20:32:47 -0500 Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by orsmga106.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 18 Feb 2019 17:31:41 -0800 Received: from richard.sh.intel.com (HELO localhost) ([10.239.159.54]) by fmsmga006.fm.intel.com with ESMTP; 18 Feb 2019 17:31:40 -0800 X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.58,385,1544515200"; d="scan'208";a="320097216" From: Wei Yang To: qemu-devel@nongnu.org, qemu-trivial@nongnu.org Date: Tue, 19 Feb 2019 09:31:06 +0800 Message-Id: <20190219013106.17538-3-richardw.yang@linux.intel.com> X-Mailer: git-send-email 2.19.1 In-Reply-To: <20190219013106.17538-1-richardw.yang@linux.intel.com> References: <20190219013106.17538-1-richardw.yang@linux.intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 134.134.136.126 Subject: [Qemu-devel] [PATCH 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: imammedo@redhat.com, mjt@tls.msk.ru, Wei Yang Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" Content-Type: text/plain; charset="utf-8" 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=C3=A9 --- CODING_STYLE | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CODING_STYLE b/CODING_STYLE index 73f66ca185..27581d80c1 100644 --- a/CODING_STYLE +++ b/CODING_STYLE @@ -134,10 +134,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: =20 -if (a =3D=3D 1) { - /* Reads like: "If a equals 1" */ - do_something(); -} + if (a =3D=3D 1) { + /* Reads like: "If a equals 1" */ + do_something(); + } =20 Rationale: Yoda conditions (as in 'if (1 =3D=3D a)') are awkward to read. Besides, good compilers already warn users when '=3D=3D' is mis-typed as '= =3D', --=20 2.19.1