doc/contributing: add line continuation note to meson guide
Checks
Commit Message
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
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.
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
> +
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
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.
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.
@@ -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: