DPDK patches and discussions
 help / color / mirror / Atom feed
From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org
Cc: david.marchand@redhat.com, Bruce Richardson <bruce.richardson@intel.com>
Subject: [dpdk-dev] [PATCH] doc/contributing: add line continuation note to meson guide
Date: Wed, 15 Sep 2021 10:50:36 +0100	[thread overview]
Message-ID: <20210915095036.22346-1-bruce.richardson@intel.com> (raw)

Add a note for the preference of using "()" rather than "\" for line
continuations in meson.

Suggested-by: David Marchand <david.marchand@redhat.com>
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 doc/guides/contributing/coding_style.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/doc/guides/contributing/coding_style.rst b/doc/guides/contributing/coding_style.rst
index d648689f10..b27b5fcfdb 100644
--- a/doc/guides/contributing/coding_style.rst
+++ b/doc/guides/contributing/coding_style.rst
@@ -1024,6 +1024,16 @@ The following guidelines apply to the build system code in meson.build files in
 * 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.
 
+* Where a line is split in the middle of a statement, e.g. a multiline `if` statement,
+  brackets should be used in preference to escaping the line break.
+
+Example::
+
+    if (condition1 and condition2            # line breaks inside () need no escaping
+            and condition3 and condition4)
+        x = y
+    endif
+
 * 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:
-- 
2.30.2


             reply	other threads:[~2021-09-15  9:50 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-15  9:50 Bruce Richardson [this message]
2021-09-15 15:04 ` David Marchand
2021-09-23 11:48   ` Thomas Monjalon
2021-09-16  7:57 ` Thomas Monjalon
2021-09-16  8:31   ` Bruce Richardson
2021-09-16  8:44     ` 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=20210915095036.22346-1-bruce.richardson@intel.com \
    --to=bruce.richardson@intel.com \
    --cc=david.marchand@redhat.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).