summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* Documenation: Updated "Usually October" to "October 2017" stringScott Rifenbark2017-10-068-7/+13
| | | | | | | | | | 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>
* ref-manual: Updated Metadata term in Terms sectionScott Rifenbark2017-10-061-3/+5
| | | | | | | | | | | | Provided a description for metadata in the context of the kernel that ties it to the yocto-kernel-cache Git repository rather than the old meta-* directories that were in the actual kernel trees. (From yocto-docs rev: 7105459bf687cad7d973d8bdffbc51c9ffcd9721) 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>
* ref-manual: Updated KERNEL_FEATURES variable descriptionScott Rifenbark2017-10-061-24/+33
| | | | | | | | | | Added a more relevant example from the 4.12 Yocto Linux kernel recipe. (From yocto-docs rev: 98c40729b2b22a2ac8444d899848c05880cb920b) 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>
* ref-manual: Updated KBRANCH variable descriptionScott Rifenbark2017-10-061-20/+25
| | | | | | | | | | | The description had gone stale and was referencing a linux yocto kernel we don't support and BSPs we don't support. Updated it. (From yocto-docs rev: 5041a2a26d703a885437abcedb24c7600d5365cd) 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-066-119/+104
| | | | | | | | | | | | | | | 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>
* ref-manual: Updated Added a New Recipe to Workspace Layer sectionKristi Rifenbark2017-10-061-12/+46
| | | | | | | | | | | | | Fixes [YOCTO #11392] Updated the section to document how to specify a branch, tag, or revision when using devtool add with a remote URL. (From yocto-docs rev: 903b4a4e72908572a5f8b8c822869bbd0fe76ec9) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated devtool --help outputKristi Rifenbark2017-10-061-36/+50
| | | | | | | | | Fixes [YOCTO #11392] (From yocto-docs rev: 30eb6ef13b85f7f5e1784dbdd6a54b1367be212d) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added NOAUTOPACKAGEDEBUG to variable glossaryKristi Rifenbark2017-10-061-0/+23
| | | | | | | | | Fixes [YOCTO #11800] (From yocto-docs rev: 789a11aee778f6082134102659b317bc6c155b4c) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@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>
* ref-manual: Updated kernel example version in PREFERRED_VERSION.Scott Rifenbark2017-09-261-3/+3
| | | | | | | (From yocto-docs rev: bc6960c01cffdc2cef7c9288db9daeed2c3e1a25) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated compatible log program section.Scott Rifenbark2017-09-261-12/+11
| | | | | | | | | Script name changed to "yocto-check-layer". (From yocto-docs rev: 545a90dd2816c4e97dc70efc76c7cca49684c2d8) 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>
* ref-manual: Updated link formatting in KBUILD_DEFCONFIG variable.Scott Rifenbark2017-09-261-4/+7
| | | | | | | (From yocto-docs rev: ba2aa642c3c1696a155b07840f84b8b3f0e692b5) 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-265-543/+592
| | | | | | | | | | | | | | 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>
* dev-manual, ref-manual: Image format implementation changesScott Rifenbark2017-09-226-53/+19
| | | | | | | | | | | | | | | Recently a number of changes have happened on the implementation side of some image formats, and a few have been renamed. The u-boot image signing code is now always available and no longer in a stand-alone file. The vmdk/mdi/qcow2 images have been removed and are now just a conversion type that is applied to wic images. Reported-by: Tom Rini <trini@konsulko.com> (From yocto-docs rev: ce86da3d48507cee12208e0138c285b4be83d8cd) 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>
* dev-manual: Replaced release names and numbers with variablesScott Rifenbark2017-09-221-17/+20
| | | | | | | | | | | In several examples, hardcoded versions of release names and versions were being used. I updated to use variables from poky.ent so that examples would use most recent release. (From yocto-docs rev: 53f8e92075cc34538f36d7fba392ea1ac9a6dd1f) 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-2214-294/+61
| | | | | | | | | | | | | | 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>
* ref-manual: Added "N" category to glossaryScott Rifenbark2017-09-221-1/+1
| | | | | | | | | | | | | Discovered this item in the front of the glossary was commented out and not showing up so the user did not have the option to click on "N" to quickly get to the "N" entries, which did exist and show up. Uncommented it and put the proper beginning "N" variable in as the start. (From yocto-docs rev: 6d51dfb9de53db1222f68a6f0325eaad1a12cd6b) 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>