summaryrefslogtreecommitdiffstats
path: root/documentation/kernel-dev
Commit message (Collapse)AuthorAgeFilesLines
* documentation: Purged overview manual referencesScott Rifenbark2018-02-141-1/+2
| | | | | | | | | | | | | | | | | | | | When I converted the Yocto Project Overview Manual to the Getting Started With Yocto Project Manual, I updated the strings for references from "&YOCTO_DOCS_OVERVIEW_URL" TO "&YOCTO_DOCS_GS_URL". Unfortunately, I did it with a global command that did not take into account the text the might follow the link by saying "see such-and-such section in the Yocto Project Overview Manual." So, I had to hand fix these. Additionally, since I have moved a deeper concepts chapter that was in the getting-started manual to a new Yocto Project Concepts chapter, many of those links changed had to really go to the new manual instead. Those were fixed. (From yocto-docs rev: fca1c56b0764802fb6a687ea81ab0fb95186cf0a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Created new "Getting Started" manual.Scott Rifenbark2018-02-143-6/+6
| | | | | | | | | | | | | | | | | | | | Creation involved removing the overview-manual and replacing it with the getting-started manual. All links to the string "&YOCTO_DOCS_OVERVIEW_URL" had to be replaced with "&YOCTO_DOCS_GS_URL" across the entire YP manual set. I renamed files used to create the manual with prefixes suited for the new manual name, which is "Getting Started With Yocto Project". The style sheet for the new manual needed updating to display the new .PNG image for the title page. The mega-manual file had to be updated to include the files. The mega-manual.sed file had to be updated to include the new manual and not use the overview manual. (From yocto-docs rev: 6c7abf9192390121000f577d6c98f259d290d15d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Created new YP Overview ManualScott Rifenbark2018-02-143-7/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | Fixes [YOCTO #12370] Added a new chapter to the newly created Yocto Project Overview Manual. This chapter originated from the YP Reference Manual and was the old chapter 3, which talked a lot about various concepts. This information is better suited for the new overview manual. The change involved moving the entire chapter and renaming it. This move of the content affected many, many external references and links into the old area. Consequently, I had to recast all these links from the different manual. Changes also included fixing the mega-manual.xml file so that it would include the new overview manual as part of it. Many figures had to be relocated as part of the move as well. This meant deleting them from the ref-manual/figures folder and putting them into the overview-manual/figures folder. (From yocto-docs rev: 87b81358f2bbd02b4a0d966d86c4d7b006d4d78f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Set up for "sumo" (YP 2.5) Release.Scott Rifenbark2017-11-121-0/+5
| | | | | | | | | | | poky.ent - updated variables <manual>.xml - updated manual revision tables mega-manual.sed - replaced "2.4" with "2.5" for links. (From yocto-docs rev: 15d1f805ad11fba145155dcec17b7ec8a21ad487) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, kernel-dev: Replaced yocto-layers with bitbake-layers commandScott Rifenbark2017-10-301-29/+29
| | | | | | | | | | | | | | | | | The yocto-layers script is being deprecated in the 2.4 YP release and the preferred script is now bitbake-layers. In particular, the section that talks about creating a general layer was using yocto-layers create. I have replaced it with bitbake-layers create-layer command. The bsp-guide and kernel-dev manual had links that used (in the case of kernel-dev) and referenced yocto-layers. I had to change these to reflect using bitbake-layers create-layers. (From yocto-docs rev: 73ec4d0c8c2c093b7c9df86038d132f0da975273) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated title page notes and author groupScott Rifenbark2017-10-301-19/+13
| | | | | | | | | | | | | Made the title page notes consistent across the manual set. Made the author group information consistent as well. It is better that authorship is seen as a third party and not tied to Intel Corporation. (From yocto-docs rev: 32cec087e384e1d92e3e84bbae5c6560a0af3136) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updated links to the SDK manual.Scott Rifenbark2017-10-301-2/+2
| | | | | | | | | | The name of the SDK manual changed and there was one link to the manual that needed fixed. (From yocto-docs rev: 800d5106a25ce4e87b0468ec3ab03dd8a49f3082) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updated dev-manual titleScott Rifenbark2017-10-303-23/+26
| | | | | | | | | | | | The name of the dev-manual has changed to be the "Yocto Project Development Tasks Manual". I have updated all the areas in the kernel-dev manual that reference sections into the dev-manual. (From yocto-docs rev: f0309ab658a259637ba7f9301031887114ade988) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updates to cull out buried YP Website references.Scott Rifenbark2017-10-161-3/+1
| | | | | | | | | | | | | With the redoing of the YP website, it was decided that the manuals could only reference into the top-level and the top-level/documentation URLs of the website. I removed all references to areas such as projects (e.g. Toaster, VM, etc.) and any other URL that was not the top-level landing page or the documentation page. (From yocto-docs rev: 2bd838f1a9fb2698bab098b13b76c8852853e0e7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Fixed typo.Scott Rifenbark2017-10-161-1/+1
| | | | | | | | Reported-by: Andrea Galbusera <gizero@gmail.com> (From yocto-docs rev: 8955c2f09a421976ce296806b572afb4c7841470) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Applied review feedbackScott Rifenbark2017-10-162-170/+61
| | | | | | | | | Various edits for review feedback on the manual in general. (From yocto-docs rev: 218061535b5bed326331d00eee6f514c81299238) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Documenation: Updated "Usually October" to "October 2017" stringScott Rifenbark2017-10-061-0/+6
| | | | | | | | | | The string in the manual revision table needed updated across the set except for the kernel-dev manual. (From yocto-docs rev: e087a707e02ff913baba2ac8bc6594206f53f70c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updated Title Page.Scott Rifenbark2017-10-061-4/+11
| | | | | | | | | | | Using Scotty's Documentation Services, INC. and Scott Rifenbark as the author. Added a note in the note box to send an email to the yocto@yoctoproject.org discussion group or log into the freenode (From yocto-docs rev: 657ef0a09a72c023dd2ab523ff3c7ad1e7a2efea) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updated Tree Construction section with review feedback.Scott Rifenbark2017-10-061-21/+44
| | | | | | | (From yocto-docs rev: c28b349a972d81d3b60bf1b0de48d837fbc76cdb) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Added KMACHINE and MACHINE descriptions for using metadataScott Rifenbark2017-10-061-6/+10
| | | | | | | | | | | | Needed to remove an old example that was showing how two BSPs could share the same KMACHINE value. I replaced it with corei7-based machines. Also noted that KMACHINE is for kernel mapping only whereas MACHINE is for the layer's BSP machine type. (From yocto-docs rev: c1dad2815b6fd1ed78e0dce0fecb422f342eaf14) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Removed note about KTYPE being optional in future.Scott Rifenbark2017-10-061-4/+0
| | | | | | | (From yocto-docs rev: 2ecf347fe5b9f60d29a5624bab2f57a7278fa9ab) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updated what the manual covers to include appendicesScott Rifenbark2017-10-061-2/+4
| | | | | | | (From yocto-docs rev: 1782241165aa09ab3d3ecf66a91a355555f5f42b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updated lists for formatting consistencyScott Rifenbark2017-10-061-2/+7
| | | | | | | (From yocto-docs rev: 7fe10c067219eccdbfd8d99223cdb38b84d7d2a5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updates to "Working With Your Own Sources"Scott Rifenbark2017-10-061-48/+74
| | | | | | | | | Formatting changes for the list. (From yocto-docs rev: df1201085408eec45d8fbf649e80437299daa0e8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Edits to "Build Strategy" section.Scott Rifenbark2017-10-061-38/+63
| | | | | | | | | | | This section was written before the yocto-kernel-cache strategy existed and was thus incorrect. I updated it with how I understand things to work. (From yocto-docs rev: 629f24c9312a168ddcd28b0d9dde92ff06068483) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updated Tree Construction sectionScott Rifenbark2017-10-061-57/+100
| | | | | | | | | | The section was using the "meta-*" stuff, which is not how it is done any longer. (From yocto-docs rev: c9d95e85a832a38c3fd099a728693af3fa708d50) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Minor updates to the "Kernel Maintenance" appendix.Scott Rifenbark2017-10-061-48/+99
| | | | | | | (From yocto-docs rev: eabeff4611d447be12af64f0f44c218c69da3409) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Minor edits to the "Advanced Kernel Concepts" appendixScott Rifenbark2017-10-061-45/+62
| | | | | | | (From yocto-docs rev: 645b642965ffcbb12f171e11a53b4efe5d0fd756) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Changed title for advanced metadata chapterScott Rifenbark2017-10-061-1/+1
| | | | | | | | | Introduced the "yocto-kernel-cache" term into the title. (From yocto-docs rev: ca74c49e2809851bb22bbe0d68830127d7bba4e9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Miscellaneous Edits to Advanced Metadata chapterScott Rifenbark2017-10-061-14/+21
| | | | | | | (From yocto-docs rev: 74e27b697efa7ea7ecc1d1d59266b537dd70ae98) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updated example in metadata outside recipe-spaceScott Rifenbark2017-10-061-43/+3
| | | | | | | | | Went from 4.4 kernel to 4.12. (From yocto-docs rev: 4cf2710a381925b8bf13536c1f8da3d12938fffe) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updates to "Using Kernel Metadata in a Recipe"Scott Rifenbark2017-10-061-21/+10
| | | | | | | | | | | This section had some old emenlo examples and was a little confusing. I removed the old examples and inserted some new wordings to help smooth it out. (From yocto-docs rev: 365129e0cd37772f404d96a51eb498210e4f1ee9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Additions to the "Overview" section.Scott Rifenbark2017-10-061-2/+22
| | | | | | | | | | I provided some background on two repositories: yocto-kernel-cache and yocto-kernel-tools. (From yocto-docs rev: 1741d6efd4ff8364a55d546897cab5e7cdee6da5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updates to "Kernel Metadata Syntax" sectionScott Rifenbark2017-10-061-104/+219
| | | | | | | | | | | Scrubbed this section to bring it up to speed with more modern BSP examples and better explanation of the types of Metadata used. (From yocto-docs rev: ba009de68a3786f83d9c3c9debffa8b811479786) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updates to where kernel metadata is foundScott Rifenbark2017-10-061-13/+7
| | | | | | | | | | | | "cfg" and "features" used to reside in the linux-yocto-x.x repo under meta. They are now in a separate repo named yocto-kernel-cache. I rewrote a couple spots that incorrectly referenced the old location. (From yocto-docs rev: e643fc3df46658b8bcf9cdc12a78b527988b63a6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Edits to the iteratively modifying source code sectionScott Rifenbark2017-10-061-88/+87
| | | | | | | | | | This section has merged into a single topic now. It still needs work but it is gathered under one heading for now. (From yocto-docs rev: 660ed8b64dedbab5400c84ec3759cea77c899c40) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Removed a comment blockScott Rifenbark2017-10-061-10/+0
| | | | | | | (From yocto-docs rev: d6cf2730a9acc9c5bfd3071794269b4e3e7273b6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Eliminated "Generating Configuration Files" section.Scott Rifenbark2017-10-064-110/+101
| | | | | | | | | | | | | | | This section was largely redundant now. The small things that did add value I placed in other areas of the chapter 2. One was a new section on expanding variables using bitbake -e. Another was a bit about the defconfig file. And a small procedure on how to create config fragments using the "diffconfig" command was retained. Links from the dev-manual and the ref-manual were adjusted as well. (From yocto-docs rev: 7059d3eac1fec20089cabf197503f1bec747686d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Added "Validating Configuration" sectionScott Rifenbark2017-10-061-49/+105
| | | | | | | | | | Provided a new section on how to validate the configuration of the kernel. (From yocto-docs rev: 25f43d1baeff7d571fc60c7edca957d4ce6d6357) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Edits to "Fine-Tuning the Kernel Configuration File"Scott Rifenbark2017-10-061-21/+44
| | | | | | | | | | This section needed some formatting to conform to the list structure used throughout the manual. (From yocto-docs rev: b6e6b66014963c1628c50e09787fdd46a45867b1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Moved "dirty" kernel procedure up a levelScott Rifenbark2017-10-061-45/+49
| | | | | | | | | | | | This procedure needed to be pulled out of the section that was/is called "Using an Iterative Development Process". The section on how to deal with "dirty" kernel version strings is a procedure in its own right. It is now up a level. (From yocto-docs rev: cd8834fa8d77ac750b06c3367aee577c80dcc64e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Removed "kernel-dev-examples.xml" file.Scott Rifenbark2017-10-061-918/+0
| | | | | | | | | File not used. (From yocto-docs rev: 208bc193b02f4644e12c7d143d20ddafc5169907) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: removed old "kernel-dev-examples.xml" chapter.Scott Rifenbark2017-10-061-4/+0
| | | | | | | | | | This chapter is not used and was commented out. I deleted the comment block. (From yocto-docs rev: c805d1034b9f9bed5990cd2bcb3a9088e3d0d542) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updated kernel configuration sectionScott Rifenbark2017-10-062-242/+244
| | | | | | | | | | | A lot of rewriting here in this section to get it up to speed. Also, moved that final section on determining hardware and non-hardware features into an appendix where it belonged. (From yocto-docs rev: 752e80d6ae8f81a0de7743b11b010d0ef36b314b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updated "in-tree" defconfig example.Scott Rifenbark2017-09-261-4/+6
| | | | | | | | | | Section "Using an 'In-Tree' defconfig File" updated to use a more syntactically correct KBUILD_DEFCONFIG_KMACHINE example. (From yocto-docs rev: 64e6b16703fa3ce9ac8db25de8089d32ac7aeafc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Compatibility program and moving kernel configurationScott Rifenbark2017-09-263-10/+526
| | | | | | | | | | | | | | Should have been two commits but I forgot to do them separately. 1. I updated the YP Compatible Program section. 2. I moved the "Configuring the Kernel" section from the dev-manual to the kernel-dev manual. (From yocto-docs rev: cdb5bbc917db55a2ca987ce9b9ed371f9fca6524) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Edits to the devtool kernel development method.Scott Rifenbark2017-09-221-154/+147
| | | | | | | | | Changes based on a run through of the procedure. (From yocto-docs rev: 0a526bb15f597843d1e5da1eeca0a952c6c5016f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Purged "oe-init-build-env-memres" from docsScott Rifenbark2017-09-221-3/+1
| | | | | | | | | | | | | | Fixes [YOCTO #11968] Purged all occurrences of the "oe-init-build-env-memres" script from the YP documentation set. Occurrences in a lot of places. The BBSERVER variable was also impacted and had to have the definition updated. (From yocto-docs rev: 274b05108d1bc53df20c11ab2efa15363bce23da) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Added note about running a clean build with a patchScott Rifenbark2017-09-221-0/+15
| | | | | | | | | | | Put this note at the end of the traditional kernel development flow. A way for the user to verify that the patch was applied for a subsequent build. (From yocto-docs rev: 598a518cd92980e1781649a3ed30ac585327dc0f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updates to the traditional kernel development flow section.Scott Rifenbark2017-09-221-41/+51
| | | | | | | (From yocto-docs rev: d81143d6ae27e2e360f923bde8e578e583a969a1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updates to creating a layer section.Scott Rifenbark2017-09-221-13/+16
| | | | | | | (From yocto-docs rev: a57ba3f227831225a544df1ab774422364b91d6f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updates to layer creation steps for kernel examples.Scott Rifenbark2017-09-221-27/+67
| | | | | | | (From yocto-docs rev: 8044f6e255905f3e4798d20e6e89aaa93d2892fb) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Added some cross-references to layer creation.Scott Rifenbark2017-09-221-6/+27
| | | | | | | (From yocto-docs rev: 67658657d10ae1e243a27ff8b3df60f31ccd9740) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updated 4.4 to 4.12 for kernel example in layerScott Rifenbark2017-09-221-32/+40
| | | | | | | (From yocto-docs rev: ba8dd3676e3800b8356b7de948ceeb6e4cba4bbf) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updates to the kernel flow proceduresScott Rifenbark2017-09-131-40/+109
| | | | | | | (From yocto-docs rev: b8baf67ece6e80884fa198ddd51715c329822f28) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-05-12 23:36:00 +0000