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

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

Hi Michael,

On Thu, 2021-07-22 at 19:10 +0200, Michael Opdenacker wrote:
> The previous syntax of the example was clearly incorrect
> The example and description were also ambiguous, one could think that
> it was "bitbake recipe" instead of "bitbake <recipename>"
> 
> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> ---
>  doc/bitbake-user-manual/bitbake-user-manual-metadata.rst | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
> index 20c330e6..01ac4d5e 100644
> --- a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
> +++ b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
> @@ -91,9 +91,10 @@ level changes:
>        Variables that are exported to the environment are preceded by the
>        string "export" in the command's output.
>  
> 
> 
> 
> --  For recipe changes, use the following::
> +-  To find changes to a given variable in a specific recipe, use the
> +   following::
>  
> 
> 
> 
> -      $ bitbake recipe -e \| grep VARIABLE="
> +      $ bitbake recipename -e | grep VARIABLENAME=\"
>  
> 
> 
> 
>     This command checks to see if the variable actually makes
>     it into a specific recipe.



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.

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

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



Cheers,

Richard