Bug 15128 - Document key variables which are space seperated to help new users
Summary: Document key variables which are space seperated to help new users
Status: RESOLVED FIXED
Alias: None
Product: BitBake User Manual
Classification: Documentation
Component: bitbake-manual (show other bugs)
Version: 4.3
Hardware: x86 Multiple
: Medium enhancement
Target Milestone: 4.3
Assignee: Michael Opdenacker
QA Contact:
URL:
Whiteboard:
Depends on:
Blocks:
 
Reported: 2023-05-30 15:45 UTC by Randy MacLeod
Modified: 2023-07-20 13:53 UTC (History)
1 user (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: Yes (doc changes required)


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Randy MacLeod 2023-05-30 15:45:49 UTC
From time to time, bitbake users suggest that bitbake could give better warnings about sytax errors. In practice this is not easy to do and if implemented is suspected to significantly degrade the parser performance. 

Alexandre Belloni who teaches Yocto to new users tells them that the simply have to memorize which key variables are space separated. We should document this list and explain in the docs that bitbake has limitations (isn't psychic).
Comment 1 Randy MacLeod 2023-05-30 15:47:32 UTC
Alex, now that you are CCed, can you write a few sentences to get Michael started or to focus the discussion in Thursdays bug review?
Comment 2 Alexandre Belloni 2023-05-30 16:44:31 UTC
IIRC, the discussion ended up with let's document the colon separated lists as most of the lists are space separated. I also replied on bug 13205, I honestly think we should simply close it.
Comment 3 Michael Opdenacker 2023-06-01 14:42:38 UTC
Will go over each variable in the glossary, and make sure that each one that wants a colon separated list is properly documented as such.

That's the best solution we found!
Comment 4 Michael Opdenacker 2023-06-21 08:11:43 UTC
Already merged one commit in BitBake:
https://git.openembedded.org/bitbake/commit/?id=d1779e2f7789e516efae434b3781c981d0ef4ded

And another one submitted for the Yocto Project manuals:
https://lore.kernel.org/yocto-docs/20230619161719.910423-1-michael.opdenacker@bootlin.com/T/#t

Once the latter is merged, we can close the bug.
Comment 5 Michael Opdenacker 2023-07-20 13:53:33 UTC
Can now close the bug thanks to this commit:
https://git.yoctoproject.org/yocto-docs/commit/?id=af5f4bfd213d2678c0f0463ddff321980d6c9669