DPDK patches and discussions
 help / color / mirror / Atom feed
From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org
Cc: Bruce Richardson <bruce.richardson@intel.com>
Subject: [dpdk-dev] [PATCH v2 13/16] doc: add meson coding style section to contributors guide
Date: Tue, 20 Apr 2021 11:22:29 +0100	[thread overview]
Message-ID: <20210420102232.314452-14-bruce.richardson@intel.com> (raw)
In-Reply-To: <20210420102232.314452-1-bruce.richardson@intel.com>

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


  parent reply	other threads:[~2021-04-20 10:24 UTC|newest]

Thread overview: 71+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-04-01 11:49 [dpdk-dev] [RFC PATCH 00/14] Build file update proposals Bruce Richardson
2021-04-01 11:49 ` [dpdk-dev] [RFC PATCH 01/14] editorconfig: add entry for meson files Bruce Richardson
2021-04-01 11:49 ` [dpdk-dev] [RFC PATCH 02/14] build: simplify library build file Bruce Richardson
2021-04-01 11:49 ` [dpdk-dev] [RFC PATCH 03/14] build: correct indentation in list of libs Bruce Richardson
2021-04-01 13:30   ` Thomas Monjalon
2021-04-01 14:01     ` Bruce Richardson
2021-04-01 11:49 ` [dpdk-dev] [RFC PATCH 04/14] build: simplify the driver build configuration file Bruce Richardson
2021-04-01 11:50 ` [dpdk-dev] [RFC PATCH 05/14] build: clean up driver list indentation Bruce Richardson
2021-04-01 12:14   ` Andrew Rybchenko
2021-04-01 12:33     ` Bruce Richardson
2021-04-01 12:40       ` Andrew Rybchenko
2021-04-01 11:50 ` [dpdk-dev] [RFC PATCH 06/14] build: reduce indentation in app build spec Bruce Richardson
2021-04-01 13:32   ` Thomas Monjalon
2021-04-01 14:05     ` Bruce Richardson
2021-04-01 11:50 ` [dpdk-dev] [RFC PATCH 07/14] build: reduce indentation in examples " Bruce Richardson
2021-04-01 11:50 ` [dpdk-dev] [RFC PATCH 08/14] build: change infrastructure file tabs to spaces Bruce Richardson
2021-04-01 11:50 ` [dpdk-dev] [RFC PATCH 09/14] lib: change meson " Bruce Richardson
2021-04-01 11:50 ` [dpdk-dev] [RFC PATCH 10/14] drivers: " Bruce Richardson
2021-04-01 11:50 ` [dpdk-dev] [RFC PATCH 11/14] examples: " Bruce Richardson
2021-04-01 11:50 ` [dpdk-dev] [RFC PATCH 12/14] app: " Bruce Richardson
2021-04-01 11:50 ` [dpdk-dev] [RFC PATCH 13/14] lib: remove librte_ prefix from directory names Bruce Richardson
2021-04-01 13:42   ` Thomas Monjalon
2021-04-01 11:50 ` [dpdk-dev] [RFC PATCH 14/14] lib: allow disabling optional libraries Bruce Richardson
2021-04-01 12:27 ` [dpdk-dev] [RFC PATCH 00/14] Build file update proposals Andrew Rybchenko
2021-04-01 13:15   ` Luca Boccassi
2021-04-01 13:36 ` Thomas Monjalon
2021-04-01 14:10   ` Bruce Richardson
2021-04-16 17:04 ` [dpdk-dev] [PATCH 00/14] Build file updates Bruce Richardson
2021-04-16 17:04   ` [dpdk-dev] [PATCH 01/14] build: simplify library build file Bruce Richardson
2021-04-16 17:04   ` [dpdk-dev] [PATCH 02/14] build: tidy up list of libraries to build Bruce Richardson
2021-04-16 17:04   ` [dpdk-dev] [PATCH 03/14] build: simplify the driver build configuration file Bruce Richardson
2021-04-16 17:04   ` [dpdk-dev] [PATCH 04/14] build: clean up driver lists Bruce Richardson
2021-04-16 17:04   ` [dpdk-dev] [PATCH 05/14] build: reduce indentation in app build spec Bruce Richardson
2021-04-16 17:04   ` [dpdk-dev] [PATCH 06/14] build: reduce indentation in examples " Bruce Richardson
2021-04-16 17:04   ` [dpdk-dev] [PATCH 07/14] build: change infrastructure file tabs to spaces Bruce Richardson
2021-04-16 17:04   ` [dpdk-dev] [PATCH 08/14] lib: cleanup whitespace in meson build files Bruce Richardson
2021-04-16 17:04   ` [dpdk-dev] [PATCH 09/14] drivers: change meson file tabs to spaces Bruce Richardson
2021-04-16 17:04   ` [dpdk-dev] [PATCH 10/14] examples: " Bruce Richardson
2021-04-16 17:04   ` [dpdk-dev] [PATCH 11/14] app: " Bruce Richardson
2021-04-16 17:04   ` [dpdk-dev] [PATCH 12/14] editorconfig: add entry for meson files Bruce Richardson
2021-04-16 17:04   ` [dpdk-dev] [PATCH 13/14] lib: remove librte_ prefix from directory names Bruce Richardson
2021-04-16 17:04   ` [dpdk-dev] [PATCH 14/14] lib: allow disabling optional libraries Bruce Richardson
2021-04-18  8:45   ` [dpdk-dev] [PATCH 00/14] Build file updates Xueming(Steven) Li
2021-04-19 13:06     ` Bruce Richardson
2021-04-21 13:01       ` Xueming(Steven) Li
2021-04-21 15:52         ` Xueming(Steven) Li
2021-04-19  0:20   ` Thomas Monjalon
2021-04-19 13:09     ` Bruce Richardson
2021-04-19 13:47       ` Thomas Monjalon
2021-04-19 14:23         ` Bruce Richardson
2021-04-20 10:22 ` [dpdk-dev] [PATCH v2 00/16] " Bruce Richardson
2021-04-20 10:22   ` [dpdk-dev] [PATCH v2 01/16] build: simplify library build file Bruce Richardson
2021-04-20 10:22   ` [dpdk-dev] [PATCH v2 02/16] build: tidy up list of libraries to build Bruce Richardson
2021-04-20 10:22   ` [dpdk-dev] [PATCH v2 03/16] build: simplify the driver build configuration file Bruce Richardson
2021-04-20 10:22   ` [dpdk-dev] [PATCH v2 04/16] build: clean up driver lists Bruce Richardson
2021-04-20 10:22   ` [dpdk-dev] [PATCH v2 05/16] build: reduce indentation in app build spec Bruce Richardson
2021-04-20 10:22   ` [dpdk-dev] [PATCH v2 06/16] build: reduce indentation in examples " Bruce Richardson
2021-04-20 10:22   ` [dpdk-dev] [PATCH v2 07/16] build: change infrastructure file tabs to spaces Bruce Richardson
2021-04-27 19:16     ` David Christensen
2021-04-20 10:22   ` [dpdk-dev] [PATCH v2 08/16] lib: cleanup whitespace in meson build files Bruce Richardson
2021-04-20 10:22   ` [dpdk-dev] [PATCH v2 09/16] drivers: change meson file tabs to spaces Bruce Richardson
2021-04-21  1:48     ` Xu, Rosen
2021-04-20 10:22   ` [dpdk-dev] [PATCH v2 10/16] examples: " Bruce Richardson
2021-04-20 10:22   ` [dpdk-dev] [PATCH v2 11/16] app: " Bruce Richardson
2021-04-20 10:22   ` [dpdk-dev] [PATCH v2 12/16] editorconfig: add entry for meson files Bruce Richardson
2021-04-20 10:22   ` Bruce Richardson [this message]
2021-04-20 10:22   ` [dpdk-dev] [PATCH v2 14/16] lib: remove librte_ prefix from directory names Bruce Richardson
2021-04-28 20:18     ` David Christensen
2021-04-20 10:22   ` [dpdk-dev] [PATCH v2 15/16] devtools: add script to ease backport of renamed files Bruce Richardson
2021-04-20 10:22   ` [dpdk-dev] [PATCH v2 16/16] lib: allow disabling optional libraries Bruce Richardson
2021-04-21 12:08   ` [dpdk-dev] [PATCH v2 00/16] Build file updates Thomas Monjalon

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210420102232.314452-14-bruce.richardson@intel.com \
    --to=bruce.richardson@intel.com \
    --cc=dev@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).