Re: [docs] [bitbake-devel] [PATCH] doc: bitbake-user-manual: fix syntax in example and improve description

["Richard Purdie" <richard.purdie@linuxfoundation.org>]

On Mon, 2021-07-26 at 17:44 +0200, Michael Opdenacker wrote:
> Hi Richard,
> 
> On 7/23/21 10:35 AM, Michael Opdenacker wrote:
> > 
> > Of course! I was wondering when we are supposed to start updating the
> > documentation. Probably right now, indeed, right?
> > 
> > > 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?
> 
> I found your script from patch messages
> (http://git.yoctoproject.org/cgit.cgi/poky-contrib/commit/?h=rpurdie/overrides-convert&id=f7c5c3bbb9bc5d4c4c8f798d64a020a4504542df),
> and it seems to do the job fine. I just had to exclude the migration
> guides, but that's easy to do it manually.

Sounds good and yes, we can just exclude those paths (we could even do that
in the script).

> How shall I proceed? Shall I send a big patch to
> docs@lists.yoctoproject.org for people to review and check that the
> output from your script is right?

We need to get final approval on exactly what we're converting, then yes.
I wanted to ensure you knew this was coming! :)

I'd note there are some _arc overrides in the docs as there as in the metadata
which need manually tweaking. I also spotted some _sh4. Those are rather obscure
and we may want to use a more common example anyway?

Cheers,

Richard