summaryrefslogtreecommitdiffstats
path: root/documentation/kernel-dev/kernel-dev-advanced.xml
Commit message (Collapse)AuthorAgeFilesLines
* kernel-dev: Reorganized Kernel Metadata Location and Syntax sectionsScott Rifenbark2017-03-241-169/+169
| | | | | | | | | | | | | It seems that the two sections "Kernel Metadata Location" and "Kernel Metadata Syntax" were flipped regarding their order of apperance in the kernel-dev manual. I belive that syntax should be first and then followed by a discussion on the location. I have swapped these section's ordering in the manual. (From yocto-docs rev: 167b088f459c7128bdc1abddd0b948be8f3bf5fe) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Corrected linking format for two variables.Scott Rifenbark2017-03-241-4/+7
| | | | | | | | | | | | | Convention is to avoid using hyperlinks for variables that appear in <literallayout>/</literallalyout> coded blocks. I removed the links for the KERNEL_FEATURES and LINUX_KERNEL_TYPE variables, which appeared in a literal block and put the links into the context of the description. (From yocto-docs rev: 3384f67e4b9f15e8f96297ceb2aafc63a5994d22) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updated the "Kernel Metadata Location" section.Scott Rifenbark2016-04-061-37/+50
| | | | | | | | | | | | | | | Fixes [YOCTO #8272] I re-wrote the section to basically consider kernel metadata coming from either inside the recipe (recipe-space) or from outside the recipe, which would be like a "kernel-cache". The re-write eliminated the term "in-tree" regarding where kernel metadata could reside. (From yocto-docs rev: d358c00fbb779328bd472494023ecb802da15d59) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Fixed missed shortcutRobert P. J. Day2015-03-101-1/+2
| | | | | | | (From yocto-docs rev: 3f9c25820bb93f8efb6eaf415e9d7a9545832a7c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updates to the "Using Kernel Metadata in a Recipe" section.Scott Rifenbark2015-03-101-7/+12
| | | | | | | | | | | Changed out the example to use some bits from the meta-xilinx layer instead of the emenlow layer. Reported-by: Robert P. J. Day <crashcourse.ca> (From yocto-docs rev: 477c62877f5882538176d0f9c8a10fc4cf878628) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide, kernel-dev, ref-manual: KERNEL_FEATURES should refer to .scc files.Robert P. J. Day2015-03-061-2/+2
| | | | | | | | | | | Tweak a number of doc lines so that the KERNEL_FEATURES variable refers directory to .scc files, and does not take advantage of potentially confusing shortcuts. (From yocto-docs rev: 6236fb098fc2d518f6f4f63e16b19a06a775d2d6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Substituted "emenlow" example for "fri2"Scott Rifenbark2015-03-061-5/+5
| | | | | | | (From yocto-docs rev: 786f647bfb0aca98be64a5515c1cc3b645c85d3e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Added quotes around a section cross-reference.Scott Rifenbark2015-03-061-1/+1
| | | | | | | (From yocto-docs rev: e8b4b8239c2d7ae6a5989e0f3ab82b25ccd34ae9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Fixed variable formatting.Scott Rifenbark2015-03-061-1/+1
| | | | | | | (From yocto-docs rev: f2264bc3a61c284f01e68feea86858e46bf1594d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Swapped out fri2 BSP for emenlow BSP in example.Scott Rifenbark2015-03-061-3/+3
| | | | | | | | | | | | | | In the "Using Kernel Metadata in a Recipe" section, the example called out "fri2" as an example BSP that shares the same KMACHINE. This was true last release of meta-intel but is no longer true. I used "emenlow" now as it seems to be like "fri2" was before the "fido" release. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 65516ed8f31752288eeaaacc6279f808a3a8a8df) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Scrubbed out the 3.4 kernel references.Scott Rifenbark2015-03-061-61/+67
| | | | | | | | | | | This kernel is not supported and is ancient. Many of the examples were referencing this kernel. I switched to use the 3.19 version. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: ba04c4f11a02b4562994d5d79838cd2cf90efc7e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev, ref-manual: Edits to KBRANCH.Scott Rifenbark2015-03-061-11/+17
| | | | | | | | | | Applied some edits to the areas where KBRANCH is discussed. Clarified that setting it is not optional any longer. (From yocto-docs rev: 4d0b2d92140d066048d9ff36453c7ea589eebe55) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev, ref-manual: Scrubbed out the KBRANCH_DEFAULT variable.Scott Rifenbark2015-03-061-9/+5
| | | | | | | | | | This variable is out. There were some references to deal with. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: fcdd5de04c722ebde2d3f236310c46a251cf1afc) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Scrubbed and fixed all user-supplied input formatting.Scott Rifenbark2014-10-181-17/+18
| | | | | | | | | | | In the manual I was using angled brackets to denote user-supplied input values. This was confusing so I changed to using the <replaceable></replaceable> tag pair. (From yocto-docs rev: dc73a78f11038a1ff04b16867e7513f31f02374b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, kernel-dev: Replaced routerstationpro with edgerouter.Scott Rifenbark2014-04-081-1/+1
| | | | | | | | | | | | | Fixes [YOCTO #2444] Replaced a couple instances where routerstationpro was found. This reference BSP is no longer there and has been replaced by edgerouter. (From yocto-docs rev: 7ba629cc677310f04a17636e140142695242c5d2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide, kernel-dev: Added Cross-references to "BitBake" termScott Rifenbark2014-03-301-8/+10
| | | | | | | | | | I made sure that the first occurrence of each "BitBake" term linked into the "BitBake" term as defined in the dev-manual. (From yocto-docs rev: 83e6e43d13cf5447b8ef65836d532abbb1f8b15e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updated the in-tree metadata sectionScott Rifenbark2013-09-221-0/+14
| | | | | | | | | | | | | | Fixes [YOCTO #5065] I added a blurb at the end of the section that talks about in-tree metadata. The blurb addresses situations where the user has changed the metadata but not updated the corresponding SRCREV variables in the kernel receipe. (From yocto-docs rev: 5d3dc0e6ebc40b937c3f3ef397e2c94e7cb3b69b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, kernel-manual: Added links to THISDIR variableScott Rifenbark2013-05-311-1/+1
| | | | | | | | | | | There is now a glossary description for the THISDIR variable in ref-manual. I added some cross-reference links to the variable in key places of these two manuals. (From yocto-docs rev: 0d0f756c142c506a66ebc6a1a33e9f124dafd333) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Spell checked the files and fixed appropriately.Scott Rifenbark2013-04-171-2/+2
| | | | | | | (From yocto-docs rev: 0b9510d009f6437179c3848fc14c94af07ab99e2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Removed a development note that was for Bruce Ashfield.Scott Rifenbark2013-04-171-3/+2
| | | | | | | (From yocto-docs rev: e78c2bd1ac07dbe7344e4bb0a6089f1bee7ea5ad) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Removed the "don't" contraction.Scott Rifenbark2013-04-171-1/+1
| | | | | | | (From yocto-docs rev: 8e95cfe286de36d2beace01fd885e220f4044aeb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Eliminated a redundant paragraph.Scott Rifenbark2013-04-171-20/+0
| | | | | | | | | | Noticed the exact same paragraph at the beginning of Chapter 3 that also appears in the introductory text for the manual. (From yocto-docs rev: 431cb58ca144bbf5aa49caa7dc2b728c3c92fe66) 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: 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: 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: 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-161-35/+35
| | | | | | | | | | 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: Formatted the "SCC Reference" section.Scott Rifenbark2013-01-161-0/+64
| | | | | | | (From yocto-docs rev: d688741743ff3ffeaf387dffc728af40331e8933) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Formatted "Feature Branches" section.Scott Rifenbark2013-01-161-0/+54
| | | | | | | (From yocto-docs rev: 6225075b08b3585532e60c9aebc0903a4509e51f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Formatting "Machine Branches" section.Scott Rifenbark2013-01-161-0/+182
| | | | | | | (From yocto-docs rev: 30a0d3c1ef3d91221ce3f90a3fd2f4b93bff1c30) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Formatted the "BSP Descriptions" section.Scott Rifenbark2013-01-161-105/+147
| | | | | | | (From yocto-docs rev: 9cfccb3372f47094479fb0a5ad095cf2b46f906e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Formatted "Kernel Types" section.Scott Rifenbark2013-01-161-0/+390
| | | | | | | | | | Also put in the initial text for the next section, which is "BSP Descriptions." (From yocto-docs rev: 0c9b0475d9c1a97c7b00df325dad0c830e30444b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Formatted "Features" section.Scott Rifenbark2013-01-161-0/+65
| | | | | | | (From yocto-docs rev: 500ae50979dad7f730d8c0a5e987c608422f3c71) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Formatted the "Patches" section.Scott Rifenbark2013-01-161-0/+44
| | | | | | | (From yocto-docs rev: e7de7e806d4cd02e4b5c8cb1ac237809bef5144e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Formatted the "Configuration" section.Scott Rifenbark2013-01-161-0/+98
| | | | | | | (From yocto-docs rev: 2b3be91ffdc6c27306f381cf083f4b3e805c2d38) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Formatted "Metadata Syntax" section.Scott Rifenbark2013-01-161-1/+169
| | | | | | | (From yocto-docs rev: 24fda5393103dd6dba2f7e58d023172dc2ee48ff) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>