summaryrefslogtreecommitdiffstats
path: root/documentation/kernel-dev
Commit message (Collapse)AuthorAgeFilesLines
* kernel-dev: Commented out some development notes to Darren.Scott Rifenbark2013-04-043-0/+6
| | | | | | | (From yocto-docs rev: 9981e5d85751eb6f21b1c06390158a995d7f59a8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Part 2 of 2 for YP doc integration into Eclipse.Timo Mueller2013-02-141-0/+27
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This commit adds the three *.customization.xsl files. I (Scott Rifenbark). Split the commit because after applying the 18 patches, the list of stuff to stage was huge and I did not want to add them one-by-one. So I staged them using git add -u. Here is the general cover letter information from Timo included with the 18 patches: ----------------- Hi, the generation of eclipse help files has been merged from the timo branch to the master. Since the creation of the timo branch there have been some changes to the master branch (e.g. new documentation, renamed documentation). This patch set does some cleanup for the renamed documentation and adds eclipse help generation support to the new documentation. 01: Removes the 'the' from the document titles 02..04: Cleanup obsolete artifacts resulting from the merge 05..08: Add eclipse help generation for ref-manual 09..13: Add eclipse help generation for kernel-dev 14..18: Add eclipse help generation for profile-manual Best regards, Timo (From yocto-docs rev: eff391a17d0a2403634adfb2f4cd2ff50ad0b771) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Part 1 of 2 updates to integrating docs to Eclipse help.Timo Mueller2013-02-142-4/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Hi, the generation of eclipse help files has been merged from the timo branch to the master. Since the creation of the timo branch there have been some changes to the master branch (e.g. new documentation, renamed documentation). This patch set does some cleanup for the renamed documentation and adds eclipse help generation support to the new documentation. 01: Removes the 'the' from the document titles 02..04: Cleanup obsolete artifacts resulting from the merge 05..08: Add eclipse help generation for ref-manual 09..13: Add eclipse help generation for kernel-dev 14..18: Add eclipse help generation for profile-manual Best regards, Timo This patch set originally contained 18 patches. I (Scott Rifenbark) had to push these changes as two parts. This is the first part. It does not include creation of the three cusomization files. (From yocto-docs rev: 9b1889f6e31ee70dae704fa08763fb9196616dad) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Added note for YP release requirements.Scott Rifenbark2013-02-141-0/+4
| | | | | | | | | | | The user needs to have YP 1.2.2 release or forward for the examples in the book to work. I have added a note indicating such. (From yocto-docs rev: 6fcbd3f526a13ef632c7ce5b9b4774d166b61895) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Added "-dirty String" section.Scott Rifenbark2013-01-301-0/+43
| | | | | | | | | | | | | The "-dirty" String section from the old YP Kernel Architecture and Use Manual was moved to section 2.3 of the manual. It needs to find the right area to be put in (AR for Darren). I added the AR text to the top of the section so it would not fall through the cracks. (From yocto-docs rev: eaa5b86643572a6c74028dc3330625a0bfbca50e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Added "Inspecting Changes and Commits" sectionScott Rifenbark2013-01-301-0/+108
| | | | | | | | | | | | | A Section about seeing what has changed in a kernel tree was moved from the old YP Kernel Architecture and Use Manual to this new manual. The section moved was "Change Inspection: Changes/Commits". In addition to moving the sections, I shortened them up by removing verbose parts of the section. (From yocto-docs rev: 2c620ea2bed0844b70b497dfa461c0b364312e39) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Added "Maintenance" appendix.Scott Rifenbark2013-01-302-0/+220
| | | | | | | | | | | | | | | | | New appendix required adding the kernel-dev-maint-appx.xml file. The contents are sections 3.2 and 3.3 from the old YP Kernel Architecture and Use Manual, which is "Tree Construction" and "Build Strategy." According to Darren Hart, this information should be retained for the few people on the planet that might ever need it. In addition to adding the new file, I had to add the bits to the kernel-dev.xml manual to support including the appendix when making the manual. (From yocto-docs rev: b25e40308080c59c6700e1dce8ebf6a9a2dafbcc) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Added "Kernel Architecture" section.Scott Rifenbark2013-01-302-0/+164
| | | | | | | | | | | | | | | | Moved the "Kernel Architecture" section from the YP Kernel Architecture and Use Manual to this manual. The section included the kernel-architecture-overview.png figure. So, I added that PNG file to the "figures" folder. Finally, I had to also add the PNG file to the Makefile tarfile list for kernel-dev. Note that because the figure was part of the old YP Kernel Architecture and Use Manual, I did not have to add the figure to the mega-manual tarfile list. (From yocto-docs rev: fbc5508ce162ea7915fd5dce74338b6a5bfd7ce1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Changed the FAQ to be an appendix.Scott Rifenbark2013-01-301-2/+2
| | | | | | | (From yocto-docs rev: 0439024c603fbc190741ea0cc807923bb41028a8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updates to support new concepts appendixScott Rifenbark2013-01-301-0/+2
| | | | | | | | | | Added bits to support building the new kernel concepts appendix. (From yocto-docs rev: 6d372bd12288142b09c729f877c1e894f11c7c27) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Added new appendix for kernel concepts.Scott Rifenbark2013-01-301-0/+89
| | | | | | | (From yocto-docs rev: e25465c6d177a27d3dee742ebc958ae30f968ffa) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Added an AR to the beginning for DarrenScott Rifenbark2013-01-301-0/+21
| | | | | | | | | | | | | The concepts in three bulleted items in the old kernel manual need to be present in this new manual. I put in a bit of text right at the beginning of the manual in the form of an AR for Darren. This will eventually be removed, but for now it is there so that it won't slip through the cracks. (From yocto-docs rev: 85b7300df30837f72d936f8ec1af0b2a4a9c1a88) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: General edits and links added.Scott Rifenbark2013-01-271-21/+27
| | | | | | | | | | | | Many links added to the glossary variables that were introduced in the manual. Also provided general edits as I found them. (From yocto-docs rev: 1c004144669306e87ad783df766b5245e474f549) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Links and edits to the Common Tasks chapter.Scott Rifenbark2013-01-271-11/+17
| | | | | | | (From yocto-docs rev: 46cd5eabe2343897eb9b4822064735bf335beb47) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Minor edits to the overview section.Scott Rifenbark2013-01-271-2/+2
| | | | | | | (From yocto-docs rev: 42c9b33d38150672d1ea177f98a86c71806caa3a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Links added for new glossary variable terms.Scott Rifenbark2013-01-161-3/+4
| | | | | | | | | | Added links for the LINUX_VERSION, LINUX_VERSION_EXTENSION, and SRCPV glossary entry terms. (From yocto-docs rev: be6c716f436a631e97f8a429aa9b2d2fa75816e5) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Fixed a typo in question 4.6.Scott Rifenbark2013-01-161-1/+1
| | | | | | | (From yocto-docs rev: 92dba7b37d3f8b1204bf08e9bedc3f820502aed3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Edits to the SCC reference section.Scott Rifenbark2013-01-161-6/+8
| | | | | | | (From yocto-docs rev: 51872ec247e93f9dd7b7c12ee32191565c30ebfa) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Edits to Advanced Metadata chapterScott Rifenbark2013-01-161-658/+0
| | | | | | | | | Removed all the orginal text. (From yocto-docs rev: 8a3b11fb6936574edb4fd0daf60d21ee2c2ccd8f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Edits to Introduction chapter.Scott Rifenbark2013-01-161-45/+0
| | | | | | | | | Removed the block of original text. (From yocto-docs rev: ff36ef73cbf50b966bf539b013260fb7c668d82e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Edits to the "Incorporating Out-of-Tree Modules" section.Scott Rifenbark2013-01-161-67/+0
| | | | | | | | | Removed the original text. (From yocto-docs rev: 0f3e89c7e6b8249cd643822f33c8168ca7cd83c9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Edits to the "Working with your Own Sources" section.Scott Rifenbark2013-01-161-7/+12
| | | | | | | | | Final tweaks to this list of variables. (From yocto-docs rev: d494c8b06a623ef4930e206dd8e5689c8a9d4923) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: transitory edits.Scott Rifenbark2013-01-161-69/+3
| | | | | | | (From yocto-docs rev: 89e6335e0e9d23a6df581ccd5f55c2a7673050cf) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updates to "Using an Iterative Development Process"Scott Rifenbark2013-01-161-129/+10
| | | | | | | | | | | Updated the name of this section to be consistent with "doing" something as the rest of the chapter is action-based. Did some other minor edits. Also, removed the original Darren text. (From yocto-docs rev: 3be86ee72766207c3812245917b8b20af86b26f4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Edits to "Modifying a Recipe" section.Scott Rifenbark2013-01-161-32/+12
| | | | | | | | | | | Edits added a couple cross-refenences back into the YP dev-manual where detailed examples of patching and configuring the kernel exist. (From yocto-docs rev: 1ae2a18f0367841d1ea9bb8d3f3d323a9b573533) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Removed original text from "Applying Patches" section.Scott Rifenbark2013-01-161-20/+0
| | | | | | | (From yocto-docs rev: 7293f8ead1ac3a8029eb7bb384e4e1b9fb71cfa1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Created new "Creating the Append File" section.Scott Rifenbark2013-01-161-35/+47
| | | | | | | | | | | fixed up the organization of how you modify a recipe. It can consist of three things. I have created a new subsection for the first item, creating the append file. (From yocto-docs rev: a8342ccf18c0406669f6983da31d38603d87921e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Edits to "Modifying an Existing Recipe"Scott Rifenbark2013-01-161-60/+34
| | | | | | | | | | Second pass through this section. Also removed the original text. Switching to numbered list. (From yocto-docs rev: 7978c5acd4776e6ade7c0ee34c6f7ab58eeb2bb9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Edits to "Creating and Preparing a Layer"Scott Rifenbark2013-01-161-26/+9
| | | | | | | | | | | | | | Changed the name of this section and took out the bit about the manual being written with the assumption of a custom layer being created. The manual does not particularly call this out with any examples so it is not needed. I pulled the copy of the original text also. (From yocto-docs rev: c7623d96ed2d9c5866e52842f8cfea2ebde95d0e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Re-write of the "Organizing Your Source" section.Scott Rifenbark2013-01-161-70/+111
| | | | | | | | | A serious pass through this system to reorganize it. (From yocto-docs rev: f13abc59730d78e5ffa5bce3d38519f8fc4c127f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Intermediary edits to the "branches" section.Scott Rifenbark2013-01-161-17/+21
| | | | | | | (From yocto-docs rev: d12e98f4b80feb1538b51cd9e3a8c204c86f13fc) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Edits in the Branch section.Scott Rifenbark2013-01-161-55/+50
| | | | | | | | | simple edits. (From yocto-docs rev: 3f73e53c9bdbe71f04400aedc042f19a48ea62bb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Created super section for Branches.Scott Rifenbark2013-01-161-103/+115
| | | | | | | | | | | | | The sections for "Machine Branches" and "Feature Branches" really should be encapsulated within a section on branching. Much of the text in the "Machine Branches" section presents the rationale behind both types of branches. I have created a larger section to contain these and will edit the text to fit. (From yocto-docs rev: c7c67f5867f22ebbbd49cab79bb2d4e52422ecac) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Removed recursive include statement from examples.Scott Rifenbark2013-01-161-7/+4
| | | | | | | | | | | Three instances of *.scc files were recursively including themselves. These .scc files needed to have their names changed to a file that indicated hardware support only. (From yocto-docs rev: f1c347f8f63141807084ac0a2bd3b64e138315cb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Re-write of the "BSP Description" section.Scott Rifenbark2013-01-161-52/+72
| | | | | | | | | | First re-write of this section. Terminology is an issue here. Dumping the term "ktype" for good. (From yocto-docs rev: e5ee05c5bfec2a0c62b89245efbe248a66b66288) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Re-write of the "Kernel Types" section.Scott Rifenbark2013-01-161-34/+40
| | | | | | | | | First real re-write of this section. (From yocto-docs rev: 636a852d4748904df6794bef391f7f5ef3db3c0f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Re-write of the "Features" section.Scott Rifenbark2013-01-161-11/+11
| | | | | | | | | first real re-write of this section. (From yocto-docs rev: 09a9d0978d939f40782179f9fd46ccd7b999c262) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: First re-write of the "Patches" section.scott-lenovo2013-01-161-6/+9
| | | | | | | (From yocto-docs rev: 64e2b623e040efeefdef572024c867a57a883f24) Signed-off-by: scott-lenovo <scott-lenovo@ubuntu.(none)> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Edits to the "Configuration" section.scott-lenovo2013-01-161-14/+19
| | | | | | | | | First real re-write of this original text. (From yocto-docs rev: a6d16b61057df8ed811cf1f5f27c5f9e08be1108) Signed-off-by: scott-lenovo <scott-lenovo@ubuntu.(none)> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: edits to the "Kernel Metadata Syntax" section.scott-lenovo2013-01-161-65/+82
| | | | | | | | | First real re-write of this section. (From yocto-docs rev: 41c79da0832c0b290b21cc2aff87091d7243fafa) Signed-off-by: scott-lenovo <scott-lenovo@ubuntu.(none)> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-ref: Edits to Recipe-Space Metadata" section.scott-lenovo2013-01-161-15/+14
| | | | | | | | | | This is the first serious re-write of the text from the original. Edits to make it more readable. (From yocto-docs rev: 21c77fdfc9ae1a02b1d02fb113324c96c6aecb5e) Signed-off-by: scott-lenovo <scott-lenovo@ubuntu.(none)> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: General edits to "Kernel Metadata Location" section.Scott Rifenbark2013-01-161-24/+20
| | | | | | | | | First real pass at cleaning up the text. (From yocto-docs rev: a550e96780b5be191a576bbb20ef28a36b20e0bc) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Edits to using metadata in a recipe section.Scott Rifenbark2013-01-161-37/+43
| | | | | | | | | General edits to clarify the writing. (From yocto-docs rev: 0510ab0faf81e0ac1c931863337eb217581c66ed) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: removed "many" based on Darren's Feedback.Scott Rifenbark2013-01-161-1/+1
| | | | | | | (From yocto-docs rev: 4f0de9cd389f37f86c2f88e399e52a284a4f870b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: General edits during re-write.Scott Rifenbark2013-01-161-20/+33
| | | | | | | (From yocto-docs rev: 7fc9b1bdeb63c32252a243ab21e31ba25779bb1b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Edits to the introduction chapter.Scott Rifenbark2013-01-162-66/+91
| | | | | | | | | | I did some re-writing for better understanding based on what I know. (From yocto-docs rev: fc3adb037ac07a90dfbba6b76643391480e0bce5) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Fixed the COMPATIBLE_MACHINE example.Scott Rifenbark2013-01-161-3/+2
| | | | | | | (From yocto-docs rev: ea9a862b3840075cfb197bf00cb96b616873f0ea) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: General edits for "Working with your own Sources"Scott Rifenbark2013-01-161-19/+25
| | | | | | | (From yocto-docs rev: d5627b98c98e47b963da35eefeb9808877dae296) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: General edits up to section 2.4.scott-lenovo2013-01-161-10/+11
| | | | | | | (From yocto-docs rev: 2df095c98a6fa034cb39f952db27d1ab55849000) Signed-off-by: scott-lenovo <scott-lenovo@ubuntu.(none)> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updates to the introduction chapter.scott-lenovo2013-01-161-3/+9
| | | | | | | | | General edits for readability, etc. (From yocto-docs rev: eb52c743ad0fba7859ee4800f12981294aa71b23) Signed-off-by: scott-lenovo <scott-lenovo@ubuntu.(none)> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>