From nobody Sun Nov 9 17:55:24 2025 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 1551058090661721.3721811663838; Sun, 24 Feb 2019 17:28:10 -0800 (PST) Received: from localhost ([127.0.0.1]:58348 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gy53s-0000nl-Lh for importer@patchew.org; Sun, 24 Feb 2019 20:28: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 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 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 X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.58,409,1544515200"; d="scan'208";a="146205282" 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 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.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+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 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: =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 + +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 =3D=3D 1 && + b =3D=3D 2) { + + while (a =3D=3D 1 && + b =3D=3D 2) { + + do_something(arg1, arg2, + arg3); + +One exception for function is indenting following lines relative to functi= on +name start: + + do_something(arg1, arg2, + arg3); + 2. Line width =20 Lines should be 80 characters; try not to make them longer. --=20 2.19.1