Skip to contentSkip to conversation

doc/contributing: add line continuation note to meson guide

PATCH Applied Bruce Richardson 3 participants 6 messages Sep 15, 2021 – Sep 23, 2021

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc/contributing: add line continuation note to meson guide

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

---
 doc/guides/contributing/coding_style.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)
doc/guides/contributing/coding_style.rst +10 -0
index d648689f10..b27b5fcfdb 100644
@@ -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:
Signature · 1 line
2.30.2
#3 lore raw
In reply to Bruce Richardson

15/09/2021 11:50, Bruce Richardson:

Quoted 7 lines

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

---
 doc/guides/contributing/coding_style.rst | 10 ++++++++++

This is not the Meson guide.

doc/guides/contributing/coding_style.rst The following guidelines apply to the build system code in meson.build files in · line 1028

Quoted 8 lines
doc/guides/contributing/coding_style.rst +2 -0
@@ -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.

Should we specify it is about Meson?

Quoted 8 lines
doc/guides/contributing/coding_style.rst +8 -0
+
+Example::
+
+    if (condition1 and condition2            # line breaks inside () need no escaping
+            and condition3 and condition4)
+        x = y
+    endif
+
#4 lore raw
Quoted 11 lines · Thomas Monjalon

15/09/2021 11:50, Bruce Richardson:

Quoted 7 lines

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

---
 doc/guides/contributing/coding_style.rst | 10 ++++++++++

This is not the Meson guide.

"coding style guide sub-section for meson" was too long to fit in the header.
:-)

Quoted 11 lines

doc/guides/contributing/coding_style.rst The following guidelines apply to the build system code in meson.build files in · line 1028

Quoted 8 lines
doc/guides/contributing/coding_style.rst +2 -0
@@ -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.

Should we specify it is about Meson?

It's in a section entitled "Meson Coding Style"[1] so that should not be necessary.

[1]https://doc.dpdk.org/guides-21.08/contributing/coding_style.html#meson-coding-style

#5 lore raw

16/09/2021 10:31, Bruce Richardson:

Quoted 27 lines · Thomas Monjalon
Quoted 11 lines

15/09/2021 11:50, Bruce Richardson:

Quoted 7 lines

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

---
 doc/guides/contributing/coding_style.rst | 10 ++++++++++

This is not the Meson guide.

"coding style guide sub-section for meson" was too long to fit in the header.
:-)

Quoted 11 lines

doc/guides/contributing/coding_style.rst The following guidelines apply to the build system code in meson.build files in · line 1028

Quoted 8 lines
doc/guides/contributing/coding_style.rst +2 -0
@@ -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.

Should we specify it is about Meson?

Quoted 5 lines

It's in a section entitled "Meson Coding Style"[1] so that should not be necessary.

[1]https://doc.dpdk.org/guides-21.08/contributing/coding_style.html#meson-coding-style

OK I missed it. Sorry for the noise.