public inbox for docs@lists.yoctoproject.org
 help / color / mirror / Atom feed
From: "Richard Purdie" <richard.purdie@linuxfoundation.org>
To: Michael Opdenacker <michael.opdenacker@bootlin.com>,
	 bitbake-devel@lists.openembedded.org
Cc: docs@lists.yoctoproject.org
Subject: Re: [docs] [bitbake-devel] [PATCH] doc: bitbake-user-manual: fix syntax in example and improve description
Date: Mon, 26 Jul 2021 22:39:26 +0100	[thread overview]
Message-ID: <abcf80a591582aac4438ce09ec1fa08a7b124117.camel@linuxfoundation.org> (raw)
In-Reply-To: <80d7406b-0b12-feaf-7381-56c815062122@bootlin.com>

On Fri, 2021-07-23 at 10:35 +0200, Michael Opdenacker wrote:
> Hi Richard,
> 
> On 7/23/21 12:14 AM, Richard Purdie wrote:
> > I should probably highlight there is a new command, "bitbake-getvar":
> > 
> > http://git.yoctoproject.org/cgit.cgi/poky/commit/?id=7bbeddeee1992d8c8fb71ba2dd49b03d0ae1ce86
> > 
> > We probably want to document that.
> 
> 
> Sure, this sounds like a very good idea indeed. I'll take care of that.

Thanks.

> > Whilst I'm thinking about it, the override discussions on the architecture list
> > are going to have implications for documentation too.
> > 
> > http://git.yoctoproject.org/cgit.cgi/poky/commit/?id=75fad23fc06c008a03414a1fc288a8614c6af9ca
> 
> 
> Of course! I was wondering when we are supposed to start updating the
> documentation. Probably right now, indeed, right?

I think we need to get final approval on what we're converting on the
openembedded-architecture list, then we can start.

> > An example of my scripted conversion run against the manuals is included
> > in this commit:
> > 
> > http://git.yoctoproject.org/cgit.cgi/poky-contrib/diff/documentation/ref-manual/variables.rst?h=rpurdie/overrides-convert&id=9ac22a64a4c0ac4640552e90674e6459f0fece9a
> 
> Where can I find the script (or commands) that you used to modify the
> documentation?

It was done with a script in the same tree:

http://git.yoctoproject.org/cgit.cgi/poky-contrib/commit/?h=rpurdie/overrides-convert&id=f7c5c3bbb9bc5d4c4c8f798d64a020a4504542df

Not pretty or efficient but does roughly what we need. I'm still working on it
with some build tests on master-next to see how close this is to working.

The main issue is the script doesn't spot some manual/docs specific example 
overrides.

Cheers,

Richard



  reply	other threads:[~2021-07-26 21:39 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-07-22 17:10 [PATCH] doc: bitbake-user-manual: fix syntax in example and improve description Michael Opdenacker
2021-07-22 22:14 ` [bitbake-devel] " Richard Purdie
2021-07-23  8:35   ` [docs] " Michael Opdenacker
2021-07-26 21:39     ` Richard Purdie [this message]
     [not found]   ` <16945E9217B4CF53.14473@lists.openembedded.org>
2021-07-26 15:44     ` Michael Opdenacker
2021-07-26 21:45       ` Richard Purdie

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=abcf80a591582aac4438ce09ec1fa08a7b124117.camel@linuxfoundation.org \
    --to=richard.purdie@linuxfoundation.org \
    --cc=bitbake-devel@lists.openembedded.org \
    --cc=docs@lists.yoctoproject.org \
    --cc=michael.opdenacker@bootlin.com \
    /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