summaryrefslogtreecommitdiffstats
path: root/documentation/kernel-dev
Commit message (Collapse)AuthorAgeFilesLines
* 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>
* kernel-dev, mega-manual: kernel dev flow fig update and chapter revsScott Rifenbark2017-09-132-0/+3
| | | | | | | | | | | | Updated the kernel development flow diagram to have an arrow from the repositories to the box that says you need to clone the kernel repository. Also, provided some wording changes in the end of the chapter. (From yocto-docs rev: c77cff4f7b0795d5429dc47c2ad63aec6d19d513) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updated list of kernel repositories to have 4.12 and cacheScott Rifenbark2017-09-131-0/+14
| | | | | | | | | | | I added the linux-yocto-4.12 kernel repository and the linux-yocto-cache repository to the list of Yocto Linux Kernel repositories in the Source Repositories. (From yocto-docs rev: 88fedda0fa4a4dfc468f0dc404fa9f04390cbed7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updates to the kernel patch examples.Scott Rifenbark2017-09-131-111/+22
| | | | | | | | | | Switching to kernel version 4.12. Pulled some old commented stuff out. (From yocto-docs rev: c0a5c886256d3477ddaf670df4939bec1c73152e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Added the host prep for kernel dev to the chapter.Scott Rifenbark2017-09-131-12/+565
| | | | | | | (From yocto-docs rev: 7343f1108808bb3be182af58325f9e3195ff4d8e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updates to the intro chapterScott Rifenbark2017-09-131-363/+80
| | | | | | | | | | | | I moved the flow diagram up higher and completely removed the procedures to get the build host ready for kernel development. Those are now in the common tasks chapter. Lots of rewriting Signen-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updated the kernel flow diagramScott Rifenbark2017-09-131-0/+0
| | | | | | | | | | Had to account for devtool and traditional kernel methods now. (From yocto-docs rev: 74580d9a61fa012406059ba2a3348d38fdc24d4c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Removed bad reference for creating patches.Scott Rifenbark2017-09-021-3/+0
| | | | | | | | | | | We do not want to mix traditional kernel development with kernel development using devtool. This reference implied that was okay to do. (From yocto-docs rev: 38c3a5d3b47e15880ca10ed30ae4a450ecc851cd) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Added output to kernel clone example.Scott Rifenbark2017-09-021-2/+10
| | | | | | | (From yocto-docs rev: d5880262ab74499fbeef620af7907ee6e5d328fd) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Removed bare clone stuff for trad. kernel dev.Scott Rifenbark2017-09-021-84/+8
| | | | | | | | | | | Bare clone setup is no longer recommended or necessary for traditional kernel development. All that is required is to clone the kernel Git repo locally. (From yocto-docs rev: cbe6d79da4fc2d5bba530b0fe6abead7783bdfbe) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Some cleanup of the output for the kernel flow ex.Scott Rifenbark2017-09-022-86/+5
| | | | | | | (From yocto-docs rev: 30bbe308339ad0665d59d8238e9420d1d594332e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, kernel-dev: Working kernel flow process using devtoolScott Rifenbark2017-09-022-369/+395
| | | | | | | | | | | A work-in-progress of an example that modifies the kernel using the devtool. The procedure is not complete yet as it does not run properly. (From yocto-docs rev: 462ba2e46f237c294f05805ad5044291a085975d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added "next steps" for setting up a native linux hostScott Rifenbark2017-09-021-33/+173
| | | | | | | | | | | | The end of this section did not direct the user to the next logical step for preparing a development host. I added a paragraph to guide the user to the next area they would need to read based on their development methods. (From yocto-docs rev: 4a1aa7800e7bca82dddef0ed83e14e075b3aa9f2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updates on how to prepare for kernel modification.Scott Rifenbark2017-09-022-1/+71
| | | | | | | | | WIP at this point. (From yocto-docs rev: 12e44f6ee7f9437d85c33d0789dbafe937af5664) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updated step 1 of flow and intro verbiageScott Rifenbark2017-09-021-5/+24
| | | | | | | | | | Updated the step to include proper links and verbiage for setting up the system for YP development. (From yocto-docs rev: d5d908847d66178a995d2be985c605e6a5c48d76) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev, dev-manual: Moved Kernel prep stepsScott Rifenbark2017-09-025-17/+203
| | | | | | | | | | | | | | | | | The dev-manual had a place-holder section for getting the build host ready for using YP and then doing kernel development. This stuff is better suited for the actual kernel development manual. I moved the section. Moving created several broken links in the manual set that had to be fixed. In the dev-manual, I updated the introductory list to include the newly moved kernel stuff. (From yocto-docs rev: 2e21260bb5f84e9e30eb353ec841d5962e8a7642) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, kernel-dev, sdk-manual: Moved patching kernel sectionScott Rifenbark2017-09-023-14/+363
| | | | | | | | | | | | | | Moved the "Patching the Kernel" section, which was in the dev-manual to the kernel-dev manual. During the move, renamed the section to "Using devtool to Patch the Kernel". This move bothered a lot of links so I had to fix them in various manuals. (From yocto-docs rev: a000be1eddf33e4d7de8f350e076d48e27ca4b98) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updated kernel dev flow figure and supporting text.Scott Rifenbark2017-09-022-17/+5
| | | | | | | (From yocto-docs rev: 68dafc1a68d48a8fe5292185d5ca62d1bdcd80ab) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updated "Creating and Preparing a Layer" sectionScott Rifenbark2017-09-021-9/+13
| | | | | | | | | | | This section failed to mention the "yocto-layer create" script, which is a simple way to create a layer. I have added this info into the section by way of a "Tip" box. (From yocto-docs rev: cf204f2b72b1da0104315f54cfe55c3f1eaf0f96) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updates to "Using .bbappend Files in Your Layer"Scott Rifenbark2017-08-091-1/+1
| | | | | | | | | | | | | | | I did some rewriting for clarity in the "Using .bbappend Files in Your Layer" section. The section needed to be retitled so focus on the layer aspect of .bbappend files. Also, while I was in there, I did more work on the prose in general. Also had to fix some links in the bsp, kernel, and ref manuals that linked into the section whose name I changes. (From yocto-docs rev: a82bcc9fe0f909135434ee1bd36b4414f6c046c9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Added the "writernotes" style.Scott Rifenbark2017-07-121-0/+4
| | | | | | | (From yocto-docs rev: 5ba749bf7a169ba1eb5440f93a00a093a07641a9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Moved devtool workflow to sdk manualScott Rifenbark2017-07-121-4/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Fixes [YOCTO #11630] The section on the devtool workflow in the dev-manual was 99% identical to what was in the sdk-manual. I have moved the workflow procedure from the old "Model" chapter of the dev-manual to be merged with what was in the sdk-manual. In truth, the only things added were a note about devtool not being exclusive to SDK development. The result of moving (deleting) this section was that the "model" chapter of the dev-manual went away. The devtool stuff, Quilt, devshell, and python shell are all out now and there is no chapter left. So, mega-manual had to be adjusted to not pull that chapter in when building the dev-manual. I had to delete three figures that were used in the flow. The figures were already replicated in the sdk-manual. The figures were deleted from the figures folder of both the dev-manual and the mega-manual. I had to make sure all references to the old devtool stuf in the YP doc set were adjusted. (From yocto-docs rev: 5dbd643d31ab502df53a22229e457a03da7772b7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Formatting and cleanup for "Other Resources"Scott Rifenbark2017-07-121-37/+45
| | | | | | | | | Some general cleanup and formatting. (From yocto-docs rev: 8d4458f8fbe02cb8bfa78cbf18726cdd8126850a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev, dev-manual: Moved Kernel workflow section to kernel-devScott Rifenbark2017-07-123-98/+227
| | | | | | | | | | | | | | | | Fixes [YOCTO #11630] The overview section of modifying the kernel needed to be in the kernel-dev manual and not in the dev-manual. I moved it and took care of all the links and external references throughout the YP doc set. One figure was involved that had to be moved to the figures folder in kernel-dev from dev-manual. That is why the Makefile had to be edited. (From yocto-docs rev: 3a704b64544678785b883f82d6e82aedac6790c5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, kernel-dev: Moved the kernel build hierarchy sectionScott Rifenbark2017-07-122-0/+87
| | | | | | | | | | | | | | Fixes [YOCTO #11630] The section that presented the Yocto Linux kernel file structure resulting from a build using BitBake needed to be in the kernel-dev manual. I moved it over. This required transferring over a figure as well. (From yocto-docs rev: 0abc6c7d87a6aa10dac28fefbb280eb51fea61a7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Re-write of Yocto Linux Architecture and Branch StrategiesScott Rifenbark2017-07-121-182/+192
| | | | | | | | | | | | This section in Appepndix A was full of redundancies used to explain how the Yocto Project kernel development team has set up branching and kernel architecture. I consolidated a couple sub-sections into just the necessary single section. (From yocto-docs rev: e42efe28aec6bad3779c4b9ea58941272fb01651) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Inserted section on Git as a relavent noteScott Rifenbark2017-07-121-28/+31
| | | | | | | | | | | | Appendix A of the kernel-dev had a subsection dedicated to just saying Git was the SCM used by the YP team for development. Having this information in a dedicated section was overkill. The information is better as an "aside". I put the stuff in a note. (From yocto-docs rev: 7e28686f946188daaf0480d4cd68e0e8ff854d37) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>