Bug 5093 - add pointer to kernel architecture manuals
Summary: add pointer to kernel architecture manuals
Status: RESOLVED FIXED
Alias: None
Product: Kernel Development
Classification: Documentation
Component: kernel-development (show other bugs)
Version: 1.5
Hardware: x86 Multiple
: Low normal
Target Milestone: 1.5 M5
Assignee: Scott Rifenbark
QA Contact:
URL:
Whiteboard: 07 October 2013: RESOLVED
Depends on:
Blocks:
 
Reported: 2013-09-01 12:22 UTC by Peter A. Bigot
Modified: 2013-10-07 16:42 UTC (History)
3 users (show)

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


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Peter A. Bigot 2013-09-01 12:22:35 UTC
In https://lists.yoctoproject.org/pipermail/linux-yocto/2013-August/000949.html Brusce Ashfield mentions additional "kernel architecture" manuals that were "moved to a harder to find area of the Yocto site".  A link to those materials should be added to the Other Resources section.
Comment 1 Scott Rifenbark 2013-09-03 10:39:44 UTC
Currently, we have a "Yocto Project Linux Kernel Development Manual" listed on our Yocto Project website (http://www.yoctoproject.org).  This manual is a mainstream YP manual that is visible at the same level as the other YP manuals from the "Documentation" page of the website.  

I don't understand the exact nature of this bug where you say links should be made in the "Other Resources" section.  Can you explain in more detail where you think the links should be?

Thanks, 
Scott
Comment 2 Peter A. Bigot 2013-09-03 11:22:21 UTC
Sorry; I thought that was implicit since this bugzilla product showed up as:

Kernel Development:  	Defects within the Yocto Project's Kernel Development Manual.

Recent discussion as referenced revealed that there is additional detail that was removed from earlier versions of that manual.  This detail would help new kernel developers understand how the underlying system works.

So yes, once Bruce (not "Brusce", sorry about that) locates the new location of the relevant material a link to it should be added to the "Other Resources" section of the "Yocto Project Linux Kernel Development Manual".
Comment 3 Scott Rifenbark 2013-09-03 11:27:21 UTC
Ahh... got it now.  Ok - I will update that section of the manual when we get some information from Bruce.  I should have understood that the section was in the manual that the bug was filed against :)  My bad. 

Thanks,
Scott
Comment 4 Darren Hart 2013-09-04 16:52:07 UTC
I agree the kernel dev manual should link to the architecture manual, but we need to cautious regarding what we put in the architecture manual. If the information is needed to make use of the linux-yocto tooling for BSPs or recipes, it belongs in the development manual.
Comment 5 Darren Hart 2013-09-05 03:58:03 UTC
Scott, do you have the necessary information to move to Accepted? If not, what is missing?
Comment 6 Scott Rifenbark 2013-09-27 21:36:05 UTC
I don't have the location of the information that was in the old architecture manual so I can't point to it.  BTW - the old architecture manual was retired last release so we can't reference it.

I am unsure at this point if any information we culled from the old architecture manual surfaced in a different form that we could reference.  

Scott
Comment 7 Darren Hart 2013-09-27 21:42:59 UTC
I thought the relevant bits had been moved to the appendix of the kernel-dev manual?
Comment 8 Scott Rifenbark 2013-09-27 21:57:07 UTC
Appendix A covers the old branching strategy and organization stuff and Appendix B covers kernel maintence, which was also from the old architecture manual.  Here are some links.  Does this satisfy the bug?

http://www.yoctoproject.org/docs/1.5/kernel-dev/kernel-dev.html#kernel-dev-concepts-appx

http://www.yoctoproject.org/docs/1.5/kernel-dev/kernel-dev.html#kernel-dev-maint-appx

Scott
Comment 9 Peter A. Bigot 2013-09-29 12:21:03 UTC
If there isn't anything else available, then there's certainly no way to add a link to it.  I'll leave the final assessment to Bruce since he knows what information he thought had been moved somewhere else.

The appendixes were there before I had trouble figuring out how to manage kernel metadata, and I did read them, so there's still documentation to be added but that's not part of this 1.5-oriented bug.
Comment 10 Bruce Ashfield 2013-09-30 13:44:59 UTC
Let me see what I can dig up for this. I've been squashing other bugs, but am back
to documentation updates now.
Comment 11 Bruce Ashfield 2013-10-03 18:36:47 UTC
I had a look, and yes, the appendixes are part of the information I was thinking of.
I also have a "linux-yocto from scratch" document that I wrote, which likely fills in the
missing gaps.

So for 1.5, perhaps we can consider this "done" (if you can call it that), and for 1.6, 
I can queue up the new content, working with Peter to make sure it covers the 
areas he is looking for.
Comment 12 Peter A. Bigot 2013-10-03 18:42:18 UTC
That'd work for me.  Thanks.
Comment 13 Scott Rifenbark 2013-10-07 16:42:23 UTC
Hi, 

Okay, so based on the last few comments, I am going to mark this bug RESOLVED and the doc changes as "completed."  

Thanks, 
Scott