docs.lists.yoctoproject.org archive mirror
 help / color / mirror / Atom feed
From: "Michael Opdenacker" <michael.opdenacker@bootlin.com>
To: "Robert P. J. Day" <rpjday@crashcourse.ca>,
	Quentin Schulz <quentin.schulz@theobroma-systems.com>
Cc: YP docs mailing list <docs@lists.yoctoproject.org>
Subject: Re: [docs] [PATCH] dev-manual: add line continuations for aesthetics
Date: Thu, 2 Sep 2021 19:50:27 +0200	[thread overview]
Message-ID: <e9d56be9-4f0b-feef-7ee5-2d1d883796d2@bootlin.com> (raw)
In-Reply-To: <5458d17c-ba98-7e9a-e351-8f91dbbd6912@crashcourse.ca>

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


      reply	other threads:[~2021-09-02 17:50 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
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 message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=e9d56be9-4f0b-feef-7ee5-2d1d883796d2@bootlin.com \
    --to=michael.opdenacker@bootlin.com \
    --cc=docs@lists.yoctoproject.org \
    --cc=quentin.schulz@theobroma-systems.com \
    --cc=rpjday@crashcourse.ca \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).