Re: [docs] [PATCH 13/34] ref-manual: add pressure limit variable documentation

Paul Eggleton
2022-10-16T20:38:38Z

On Tuesday, 11 October 2022 23:30:50 NZDT Michael Opdenacker via
lists.yoctoproject.org wrote:
> Actually, these have recently been accepted in the BitBake manual (the
> patches from Aryaman got accepted after he left WindRiver), though
> apparently with fewer details:
> https://git.openembedded.org/bitbake/commit/?id=c014281f72f4f54ec8e681ef2b8e
> 1080de9ab5cf
>
> Shall we submit your updates to the Bitbake manual instead? This way, we
> don't have these variables documented in two different places.

Ah, oops - I missed that. I'm OK with that for now; however, and I may have
also missed if this has been discussed recently, but it's my opinion that all
variables documented in the BitBake manual should also be in the Yocto
reference manual, since they are two different contexts - the catch being that
for some variables there is information you can't reasonably include in the
bitbake manual since it relies on some definitions unique to OE so the entries
can't always be copied exactly. If on the other hand some variables only
appear in the BitBake manual, there will be people who just won't find them.

To avoid things getting out of sync, we could potentially have a script that
would check for and report on variables present in the BitBake manual that
aren't in the Yocto reference manual. I'd be happy to write such a script.

Cheers
Paul