diff mbox series

doc/contributing: add line continuation note to meson guide

Message ID 20210915095036.22346-1-bruce.richardson@intel.com (mailing list archive)
State Accepted
Delegated to: Thomas Monjalon
Headers show
Series doc/contributing: add line continuation note to meson guide | expand

Checks

Context Check Description
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-spell-check-testing warning Testing issues
ci/intel-Testing fail Testing issues
ci/Intel-compilation success Compilation OK
ci/github-robot: build success github build: passed
ci/checkpatch success coding style OK

Commit Message

Bruce Richardson Sept. 15, 2021, 9:50 a.m. UTC
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(+)

Comments

David Marchand Sept. 15, 2021, 3:04 p.m. UTC | #1
On Wed, Sep 15, 2021 at 11:50 AM Bruce Richardson
<bruce.richardson@intel.com> wrote:
>
> 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>

Thanks Bruce.
Thomas Monjalon Sept. 16, 2021, 7:57 a.m. UTC | #2
15/09/2021 11:50, Bruce Richardson:
> 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 ++++++++++

This is not the Meson guide.

> --- 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.

Should we specify it is about Meson?

> +
> +Example::
> +
> +    if (condition1 and condition2            # line breaks inside () need no escaping
> +            and condition3 and condition4)
> +        x = y
> +    endif
> +
Bruce Richardson Sept. 16, 2021, 8:31 a.m. UTC | #3
On Thu, Sep 16, 2021 at 09:57:30AM +0200, Thomas Monjalon wrote:
> 15/09/2021 11:50, Bruce Richardson:
> > 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 ++++++++++
> 
> This is not the Meson guide.
> 
"coding style guide sub-section for meson" was too long to fit in the header.
 :-)

> > --- 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.
> 
> 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
Thomas Monjalon Sept. 16, 2021, 8:44 a.m. UTC | #4
16/09/2021 10:31, Bruce Richardson:
> On Thu, Sep 16, 2021 at 09:57:30AM +0200, Thomas Monjalon wrote:
> > 15/09/2021 11:50, Bruce Richardson:
> > > 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 ++++++++++
> > 
> > This is not the Meson guide.
> > 
> "coding style guide sub-section for meson" was too long to fit in the header.
>  :-)
> 
> > > --- 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.
> > 
> > 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

OK I missed it. Sorry for the noise.
Thomas Monjalon Sept. 23, 2021, 11:48 a.m. UTC | #5
15/09/2021 17:04, David Marchand:
> On Wed, Sep 15, 2021 at 11:50 AM Bruce Richardson
> <bruce.richardson@intel.com> wrote:
> >
> > 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>

Applied, thanks.
diff mbox series

Patch

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: