doc: bitbake-user-manual: fix syntax in example and improve description
PATCH 1/1 doc: bitbake-user-manual: fix syntax in example and improve description
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>"
--- doc/bitbake-user-manual/bitbake-user-manual-metadata.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)
doc/bitbake-user-manual/bitbake-user-manual-metadata.rst +3 -2
@@ -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.
Signature · 1 line
2.25.1
Hi Michael,
Quoted 33 lines · Michael Opdenacker
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 <[email protected]>---
doc/bitbake-user-manual/bitbake-user-manual-metadata.rst | 5 +++--1 file changed, 3 insertions(+), 2 deletions(-)doc/bitbake-user-manual/bitbake-user-manual-metadata.rst +0
-0@@ -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::doc/bitbake-user-manual/bitbake-user-manual-metadata.rst +1
-1- $ bitbake recipe -e \| grep VARIABLE=" + $ bitbake recipename -e | grep VARIABLENAME=\"
Quoted 2 lines
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:
Cheers,
Richard
Hi Richard,
Quoted 5 lines · Richard Purdie
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.
Quoted 5 lines
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?
Quoted 5 lines
An example of my scripted conversion run against the manuals is included in this commit:
Where can I find the script (or commands) that you used to modify the documentation?
Thanks,
Michael.
Signature · 3 lines
Michael Opdenacker, Bootlin Embedded Linux and Kernel engineering https://bootlin.com
Quoted 11 lines · Michael Opdenacker
Hi Richard,
Quoted 5 lines · Richard Purdie
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.
Quoted 8 lines
Quoted 4 lines
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.
Quoted 7 lines
Quoted 4 lines
An example of my scripted conversion run against the manuals is included in this commit:
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:
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
A message that is not in the archive (sent off-list or not yet received): [email protected]
Hi Richard,
Quoted 10 lines · Michael Opdenacker
Of course! I was wondering when we are supposed to start updating the documentation. Probably right now, indeed, right?
Quoted 4 lines
An example of my scripted conversion run against the manuals is included in this commit:
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.
How shall I proceed? Shall I send a big patch to [email protected] for people to review and check that the output from your script is right?
Thanks in advance
Michael.
Signature · 3 lines
Michael Opdenacker, Bootlin Embedded Linux and Kernel engineering https://bootlin.com
Quoted 10 lines · Michael Opdenacker
Hi Richard,
Quoted 7 lines · Michael Opdenacker
Of course! I was wondering when we are supposed to start updating the documentation. Probably right now, indeed, right?
Quoted 3 lines
An example of my scripted conversion run against the manuals is included in this commit:
Quoted 8 lines
Quoted 3 lines
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).
Quoted 3 lines
How shall I proceed? Shall I send a big patch to [email protected] 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