Bug 12399 - add non conflicting parts of the bitbake manual to the mega manual
Summary: add non conflicting parts of the bitbake manual to the mega manual
Status: RESOLVED FIXED
Alias: None
Product: Mega Manual
Classification: Documentation
Component: mega-manual (show other bugs)
Version: 2.5
Hardware: x86 Multiple
: Medium+ normal
Target Milestone: 2.7 M2
Assignee: Scott Rifenbark
QA Contact:
URL:
Whiteboard: 14 February 2019: RESOLVED
Depends on:
Blocks:
 
Reported: 2017-12-06 00:27 UTC by brian avery
Modified: 2019-02-14 22:37 UTC (History)
3 users (show)

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

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description brian avery 2017-12-06 00:27:55 UTC 
Some things, a great example from a question today is the assignment operators  ?= and ??=,  are addressed in the bitbake manual, but not really addressed in the mega manual.  Many new users know about the mega manual as they associate the name yocto with the project and docs.  Unfortunately, they do not realize that they should look in the bitbake manual for things that are not covered (or worse, are briefly covered) in the mega manual but whose real documentation is in the bitbake manual.
Comment 1 brian avery 2017-12-06 00:28:20 UTC 
+paul and rp
Comment 2 Scott Rifenbark 2017-12-08 22:34:44 UTC 
One thing we try to avoid is duplication of information.  I would rather scrub through the YP doc set and be sure that we are referencing the BB manual appropriately.  I really don't want to take information that is in the BB manual and repeat it in the YP documentation manuals.

Scott
Comment 3 Paul Eggleton 2017-12-10 21:40:44 UTC 
The mega manual already is a duplication of the other YP manuals though. The idea here would be to include verbatim the specific section files from the bitbake manual, assuming that's practical to do without mondification.
Comment 4 Scott Rifenbark 2017-12-11 22:10:25 UTC 
Paul, 

Okay - I see the difference then.  Brian is suggesting that we selectively include areas of the BB manual into the mega-manual as opposed to having that information duplicated somewhere in say the ref-manual and have it sucked into the mega-manual that way.
Comment 5 Scott Rifenbark 2018-03-30 19:03:44 UTC 
Maybe we should just include the BB manual in the mega-manual?

What do you think of that idea?

Scott
Comment 6 Richard Purdie 2018-05-10 08:23:47 UTC 
Including it sounds fine to me fwiw.
Comment 7 Scott Rifenbark 2018-05-10 09:16:12 UTC 
I also like the idea of adding the BitBake manual to the mega-manual fwiw.

I will add it in.

Scott
Comment 8 Scott Rifenbark 2018-09-26 20:31:37 UTC 
Setting this to post 2.6.  I will do this after "thud"

Scott
Comment 9 Scott Rifenbark 2018-12-27 00:41:43 UTC 
Hi, 

This bug is complete for what we wanted to do, which is include the entire BitBake User Manual into the Mega-Manual (it was an agreed upon compromise).

You can see http://www.yoctoproject.org/docs/2.7/mega-manual/mega-manual.html for the new manual that includes BB User Manual as the last manual in the mega-manual.

Note that target ID strings for variables linked in the BB manual are now unique from target IDs used in the YP Reference Manual.  So I think everything behind the scenes is good to go.

Let me know... I am putting the bug in review.  

Scott
Comment 10 Richard Purdie 2019-02-14 16:14:34 UTC 
This has now been completed, thanks Scott!
Comment 11 Scott Rifenbark 2019-02-14 22:37:07 UTC 
Thanks Richard, 

I have set the doc flag to "done".

Scott