docs.lists.yoctoproject.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] dev-manual: add line continuations for aesthetics
@ 2021-08-30  9:00 Robert P. J. Day
  2021-08-30  9:17 ` [docs] " Quentin Schulz
  0 siblings, 1 reply; 4+ messages in thread
From: Robert P. J. Day @ 2021-08-30  9:00 UTC (permalink / raw)
  To: YP docs mailing list


Not a fan of lengthy lines that require horizontal scrolling,
so add line continuations.

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>

---

diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index 4a5011ea7..6f0ee27c7 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -2331,17 +2331,39 @@ In the following example, ``mtd-utils`` is a makefile-based package::

    S = "${WORKDIR}/git"

-   EXTRA_OEMAKE = "'CC=${CC}' 'RANLIB=${RANLIB}' 'AR=${AR}' 'CFLAGS=${CFLAGS} -I${S}/include -DWITHOUT_XATTR' 'BUILDDIR=${S}'"
+   EXTRA_OEMAKE = " \
+       'CC=${CC}' \
+       'RANLIB=${RANLIB}' \
+       'AR=${AR}' \
+       'CFLAGS=${CFLAGS} -I${S}/include -DWITHOUT_XATTR' \
+       'BUILDDIR=${S}' \
+       "

    do_install () {
-       oe_runmake install DESTDIR=${D} SBINDIR=${sbindir} MANDIR=${mandir} INCLUDEDIR=${includedir}
+       oe_runmake install \
+           DESTDIR=${D} \
+           SBINDIR=${sbindir} \
+           MANDIR=${mandir} \
+           INCLUDEDIR=${includedir}
    }

    PACKAGES =+ "mtd-utils-jffs2 mtd-utils-ubifs mtd-utils-misc"

-   FILES:mtd-utils-jffs2 = "${sbindir}/mkfs.jffs2 ${sbindir}/jffs2dump ${sbindir}/jffs2reader ${sbindir}/sumtool"
+   FILES:mtd-utils-jffs2 = " \
+       ${sbindir}/mkfs.jffs2 \
+       ${sbindir}/jffs2dump \
+       ${sbindir}/jffs2reader \
+       ${sbindir}/sumtool \
+       "
    FILES:mtd-utils-ubifs = "${sbindir}/mkfs.ubifs ${sbindir}/ubi*"
-   FILES:mtd-utils-misc = "${sbindir}/nftl* ${sbindir}/ftl* ${sbindir}/rfd* ${sbindir}/doc* ${sbindir}/serve_image ${sbindir}/recv_image"
+   FILES:mtd-utils-misc = " \
+       ${sbindir}/nftl* \
+       ${sbindir}/ftl* \
+       ${sbindir}/rfd* \
+       ${sbindir}/doc* \
+       ${sbindir}/serve_image \
+       ${sbindir}/recv_image \
+       "

    PARALLEL_MAKE = ""


-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                         http://crashcourse.ca

LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================

^ permalink raw reply related	[flat|nested] 4+ messages in thread

* Re: [docs] [PATCH] dev-manual: add line continuations for aesthetics
  2021-08-30  9:00 [PATCH] dev-manual: add line continuations for aesthetics Robert P. J. Day
@ 2021-08-30  9:17 ` Quentin Schulz
  2021-08-30  9:26   ` Robert P. J. Day
  0 siblings, 1 reply; 4+ messages in thread
From: Quentin Schulz @ 2021-08-30  9:17 UTC (permalink / raw)
  To: Robert P. J. Day; +Cc: YP docs mailing list

Hi Robert,

On Mon, Aug 30, 2021 at 05:00:39AM -0400, Robert P. J. Day wrote:
> 
> Not a fan of lengthy lines that require horizontal scrolling,
> so add line continuations.
> 
> Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
> 

It is the content of the recipe afterall, so not sure it's desired? Will
let Michael/Nicolas decide.

In any case, this code is out of sync, e.g. WITHOUT_XATTR is now
embedded in a bb.utils.contains check. Since you're sending patch for
this already, do you mind sending a patch for this too please?

Cheers,
Quentin

> ---
> 
> diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
> index 4a5011ea7..6f0ee27c7 100644
> --- a/documentation/dev-manual/common-tasks.rst
> +++ b/documentation/dev-manual/common-tasks.rst
> @@ -2331,17 +2331,39 @@ In the following example, ``mtd-utils`` is a makefile-based package::
> 
>     S = "${WORKDIR}/git"
> 
> -   EXTRA_OEMAKE = "'CC=${CC}' 'RANLIB=${RANLIB}' 'AR=${AR}' 'CFLAGS=${CFLAGS} -I${S}/include -DWITHOUT_XATTR' 'BUILDDIR=${S}'"
> +   EXTRA_OEMAKE = " \
> +       'CC=${CC}' \
> +       'RANLIB=${RANLIB}' \
> +       'AR=${AR}' \
> +       'CFLAGS=${CFLAGS} -I${S}/include -DWITHOUT_XATTR' \
> +       'BUILDDIR=${S}' \
> +       "
> 
>     do_install () {
> -       oe_runmake install DESTDIR=${D} SBINDIR=${sbindir} MANDIR=${mandir} INCLUDEDIR=${includedir}
> +       oe_runmake install \
> +           DESTDIR=${D} \
> +           SBINDIR=${sbindir} \
> +           MANDIR=${mandir} \
> +           INCLUDEDIR=${includedir}
>     }
> 
>     PACKAGES =+ "mtd-utils-jffs2 mtd-utils-ubifs mtd-utils-misc"
> 
> -   FILES:mtd-utils-jffs2 = "${sbindir}/mkfs.jffs2 ${sbindir}/jffs2dump ${sbindir}/jffs2reader ${sbindir}/sumtool"
> +   FILES:mtd-utils-jffs2 = " \
> +       ${sbindir}/mkfs.jffs2 \
> +       ${sbindir}/jffs2dump \
> +       ${sbindir}/jffs2reader \
> +       ${sbindir}/sumtool \
> +       "
>     FILES:mtd-utils-ubifs = "${sbindir}/mkfs.ubifs ${sbindir}/ubi*"
> -   FILES:mtd-utils-misc = "${sbindir}/nftl* ${sbindir}/ftl* ${sbindir}/rfd* ${sbindir}/doc* ${sbindir}/serve_image ${sbindir}/recv_image"
> +   FILES:mtd-utils-misc = " \
> +       ${sbindir}/nftl* \
> +       ${sbindir}/ftl* \
> +       ${sbindir}/rfd* \
> +       ${sbindir}/doc* \
> +       ${sbindir}/serve_image \
> +       ${sbindir}/recv_image \
> +       "
> 
>     PARALLEL_MAKE = ""
> 
> 
> -- 
> 
> ========================================================================
> Robert P. J. Day                                 Ottawa, Ontario, CANADA
>                          https://urldefense.proofpoint.com/v2/url?u=http-3A__crashcourse.ca&d=DwIBAg&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=sH8iuVXeDgFiq6-2yFuaJA1ahW9robcDxSFcJtunA6g&s=ez81p3lImZGQIgOs21G8Sys-IEhCl0eRKgi70lFiDSU&e= 
> 
> LinkedIn:                               https://urldefense.proofpoint.com/v2/url?u=http-3A__ca.linkedin.com_in_rpjday&d=DwIBAg&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=sH8iuVXeDgFiq6-2yFuaJA1ahW9robcDxSFcJtunA6g&s=0YgkyEX30AN49Fm5SfWLgeNzQw7rQ_AnyZoUjBGyhtw&e= 
> ========================================================================

> 
> 
> 


^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [docs] [PATCH] dev-manual: add line continuations for aesthetics
  2021-08-30  9:17 ` [docs] " Quentin Schulz
@ 2021-08-30  9:26   ` Robert P. J. Day
  2021-09-02 17:50     ` Michael Opdenacker
  0 siblings, 1 reply; 4+ messages in thread
From: Robert P. J. Day @ 2021-08-30  9:26 UTC (permalink / raw)
  To: Quentin Schulz; +Cc: YP docs mailing list

On Mon, 30 Aug 2021, Quentin Schulz wrote:

> Hi Robert,
>
> On Mon, Aug 30, 2021 at 05:00:39AM -0400, Robert P. J. Day wrote:
> >
> > Not a fan of lengthy lines that require horizontal scrolling,
> > so add line continuations.
> >
> > Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
> >
>
> It is the content of the recipe afterall, so not sure it's desired?
> Will let Michael/Nicolas decide.
>
> In any case, this code is out of sync, e.g. WITHOUT_XATTR is now
> embedded in a bb.utils.contains check. Since you're sending patch
> for this already, do you mind sending a patch for this too please?

  in cases like this, it's pretty much a given that any recipe will be
out of date in a while, but i don't think that's a big deal -- the
idea is just to present a *concept*, not to guarantee that the recipe
matches exactly the current version. i am willing to be corrected,
though.

rday

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [docs] [PATCH] dev-manual: add line continuations for aesthetics
  2021-08-30  9:26   ` Robert P. J. Day
@ 2021-09-02 17:50     ` Michael Opdenacker
  0 siblings, 0 replies; 4+ messages in thread
From: Michael Opdenacker @ 2021-09-02 17:50 UTC (permalink / raw)
  To: Robert P. J. Day, Quentin Schulz; +Cc: YP docs mailing list

Hello,

On 8/30/21 11:26 AM, Robert P. J. Day wrote:
> On Mon, 30 Aug 2021, Quentin Schulz wrote:
>
>> Hi Robert,
>>
>> On Mon, Aug 30, 2021 at 05:00:39AM -0400, Robert P. J. Day wrote:
>>> Not a fan of lengthy lines that require horizontal scrolling,
>>> so add line continuations.
>>>
>>> Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
>>>
>> It is the content of the recipe afterall, so not sure it's desired?
>> Will let Michael/Nicolas decide.


Right, not sure there's much added value in tweaking real code. I also
checked the epub and pdf output and the lines are automatically wrapped.

>>
>> In any case, this code is out of sync, e.g. WITHOUT_XATTR is now
>> embedded in a bb.utils.contains check. Since you're sending patch
>> for this already, do you mind sending a patch for this too please?
>   in cases like this, it's pretty much a given that any recipe will be
> out of date in a while, but i don't think that's a big deal -- the
> idea is just to present a *concept*, not to guarantee that the recipe
> matches exactly the current version. i am willing to be corrected,
> though.


What could be embarrassing is when the code no longer works, so this
would be a reason for keep example code reasonably up to date. However,
I agree we shouldn't try to always keep the code excerpts in sync with
the actual code. Unless we find a way to fetch the source code directly
from the git repositories ?

Cheers,

Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com


^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2021-09-02 17:50 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-08-30  9:00 [PATCH] dev-manual: add line continuations for aesthetics Robert P. J. Day
2021-08-30  9:17 ` [docs] " Quentin Schulz
2021-08-30  9:26   ` Robert P. J. Day
2021-09-02 17:50     ` Michael Opdenacker

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