doc: add line continuation note in Meson coding style
authorBruce Richardson <bruce.richardson@intel.com>
Wed, 15 Sep 2021 09:50:36 +0000 (10:50 +0100)
committerThomas Monjalon <thomas@monjalon.net>
Thu, 23 Sep 2021 11:48:11 +0000 (13:48 +0200)
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>
Reviewed-by: David Marchand <david.marchand@redhat.com>
doc/guides/contributing/coding_style.rst

index d648689..b27b5fc 100644 (file)
@@ -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: