From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
by inbox.dpdk.org (Postfix) with ESMTP id 02AABA0548;
Tue, 20 Apr 2021 12:24:22 +0200 (CEST)
Received: from [217.70.189.124] (localhost [127.0.0.1])
by mails.dpdk.org (Postfix) with ESMTP id C89674170B;
Tue, 20 Apr 2021 12:23:38 +0200 (CEST)
Received: from mga05.intel.com (mga05.intel.com [192.55.52.43])
by mails.dpdk.org (Postfix) with ESMTP id B37E1416EE
for <dev@dpdk.org>; Tue, 20 Apr 2021 12:23:25 +0200 (CEST)
IronPort-SDR: /f/3v8fp1fTS8WU8d3GX5OBlMr1lLK/Xt9Mj46zy//ET/z0+x5M1tJjXqabR7PspIp3c5Yn3Oy
+O4PnbE6ZQLw==
X-IronPort-AV: E=McAfee;i="6200,9189,9959"; a="280809245"
X-IronPort-AV: E=Sophos;i="5.82,236,1613462400"; d="scan'208";a="280809245"
Received: from fmsmga005.fm.intel.com ([10.253.24.32])
by fmsmga105.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;
20 Apr 2021 03:23:24 -0700
IronPort-SDR: s1Yz9l+d6DDQeSJaIuuzIMPU6x1QV41NyhqyDWCjh2swwDmlSOWzPpqnAwuzMJTI61NAh+msb6
GA4wG8sg59Xw==
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.82,236,1613462400"; d="scan'208";a="616862718"
Received: from silpixa00399126.ir.intel.com ([10.237.223.116])
by fmsmga005.fm.intel.com with ESMTP; 20 Apr 2021 03:23:24 -0700
From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org
Cc: Bruce Richardson <bruce.richardson@intel.com>
Date: Tue, 20 Apr 2021 11:22:29 +0100
Message-Id: <20210420102232.314452-14-bruce.richardson@intel.com>
X-Mailer: git-send-email 2.27.0
In-Reply-To: <20210420102232.314452-1-bruce.richardson@intel.com>
References: <20210401115009.1063844-1-bruce.richardson@intel.com>
<20210420102232.314452-1-bruce.richardson@intel.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Subject: [dpdk-dev] [PATCH v2 13/16] doc: add meson coding style section to
contributors guide
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>
To help with consistency across all files, add a section to the
contributors guide on meson coding style. Although short, this covers
the basics for now, and can be extended in future as we see the need.
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
doc/guides/contributing/coding_style.rst | 46 ++++++++++++++++++++++++
1 file changed, 46 insertions(+)
diff --git a/doc/guides/contributing/coding_style.rst b/doc/guides/contributing/coding_style.rst
index fdcd21861d..dae1bd3245 100644
--- a/doc/guides/contributing/coding_style.rst
+++ b/doc/guides/contributing/coding_style.rst
@@ -1012,3 +1012,49 @@ headers
version
As above
+
+
+Meson Coding Style
+------------------
+
+The following guidelines apply to the build system code in meson.build files in DPDK.
+
+* Indentation should be using 4 spaces, no hard tabs.
+
+* Line continuations should be doubly-indented to ensure visible difference from normal indentation.
+ Any line continuations beyond the first may be singly indented to avoid large amounts of indentation.
+
+* Lists of files or components must be alphabetical unless doing so would cause errors.
+
+* Two formats are supported for lists of files or list of components:
+
+ * For a small number of list entries, generally 3 or fewer, all elements may be put on a single line.
+ In this case, the opening and closing braces of the list must be on the same line as the list items.
+ No trailing comma is put on the final list entry.
+ * For lists with more than 3 items,
+ it is recommended that the lists be put in the files with a *single* entry per line.
+ In this case, the opening brace, or ``files`` function call must be on a line on its own,
+ and the closing brace must similarly be on a line on its own at the end.
+ To help with readability of nested sublists, the closing brace should be dedented to appear
+ at the same level as the opening braced statement.
+ The final list entry must have a trailing comma,
+ so that adding a new entry to the list never modifies any other line in the list.
+
+Examples::
+
+ sources = files('file1.c', 'file2.c')
+
+ subdirs = ['dir1', 'dir2']
+
+ headers = files(
+ 'header1.c',
+ 'header2.c',
+ 'header3.c', # always include trailing comma
+ ) # closing brace at indent level of opening brace
+
+ components = [
+ 'comp1',
+ 'comp2',
+ ...
+ 'compN',
+ ]
--
2.27.0