aboutsummaryrefslogtreecommitdiffstats
path: root/documentation/kernel-dev
AgeCommit message (Collapse)Author
2016-06-06kernel-dev: Fix the locations of .config and source directoryScott Rifenbark
The locations of the kernel .config file and source direcotry moved a couple releases ago. Updated the documentation accordingly. Also added a note explaining how to check the expansion of variables, which servs a couple of purposes: * For curious readers, shows them how to understand where these variables come from and how they are used. * For suspicious readers, shows them how they can verify that the variables in the documentation are actually correct. Author: Tom Zanussi <tom.zanussi@linux.intel.com> (From yocto-docs rev: a4f92870e70cb625f2987a59aff3f460457b4889) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-06-06documentation: Prepared manuals for a 2.2 release.Scott Rifenbark
* Updated poky.ent to have the appropriate 2.2 variables * Updated all manual revision tables to have a new entry for 2.2 - used "Sometime in 2016" for the date. * Updated the mega-manual.sed file to process internal links for 2.2. (From yocto-docs rev: 2acd49ee197e3e3e725f4cb8cc432437afd8646b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-06documentation: Updated release date in manual history tables.Scott Rifenbark
Updated to "April 2016" for all manuals that use this table. (From yocto-docs rev: 4d3753cc92c446668b0c383736c2071e24e53dd2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-06kernel-dev: Applied review comments to "Adding Recipe-Space Kernel Features"Scott Rifenbark
Fixes [YOCTO #4047] I went through and fixed a few areas where reviewers said there was "quirky" phrasing. They might have been right in a few places. (From yocto-docs rev: 66fb97838f338ed3f787ec18f62702ef726ceffc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-06kernel-dev: Added new "Adding Recipe-Space Kernel Features" section.Scott Rifenbark
Fixes [YOCTO #4047] I added a new section describing how to add kernel features from within a kernel recipe through the KERNEL_FEATURES variable and the SRC_URI statement. (From yocto-docs rev: d30925c65e3f49b2ba481f1e7f9cac98fe86f6af) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-06kernel-dev: Updated the "Kernel Metadata Location" section.Scott Rifenbark
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>
2016-03-23kernel-dev: Changed a link from an example to in-text.Scott Rifenbark
Better placement of this link. It did not need to be in the <literallayout> example. (From yocto-docs rev: 53c33ea4cc929e016812f0d3aac0d302758dc0f8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-07documentation: Prepare for 2.1 buildsScott Rifenbark
The changes are for the poky.ent file and the mega-manual.sed file to take care of variables. Also, entries added for the manual revision table. (From yocto-docs rev: 60da39f85165e2d4aef55d456f8203183e089433) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-29kernel-dev: Added cross-reference to .config informationScott Rifenbark
Fixes [YOCTO #7474] There was not a strong tie between .config file discussions for the kernel between corresponding menuconfig sections in the kernel-dev and dev-manual manuals. I added a cross- reference link in the kernel-dev manual to help tie this information together. (From yocto-docs rev: bbeb7b0f48be6c2bdb6c6031ce0476d6d2081f94) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21documentation: Updated files to support 2.0 release.Scott Rifenbark
These updates included editing the poky.ent file so that DISTRO and related variables are now 2.0. Also updated all the title pages to have the manual revision table correct. Finally, used my email for the manuals. (From yocto-docs rev: deae61bfbb528ea0ced82399a78260a7f34a7a11) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28kernel-dev: Added 'make defconfig' details for own source workScott Rifenbark
I added some detail about what really happens when you use the 'make defconfig' command when working with your own sources. Fixes [YOCTO #6611] (From yocto-docs rev: 653c7726e024dcaa908127f0df1d1856f26f4ff0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28kernel-dev: Added kernel-devsrc information for building on targetScott Rifenbark
I added a clarifying paragraph at the start of the section that talks about building on the target hardware. Included kernel-devsrc and rationale for why a user would even do this (it is not normal). (From yocto-docs rev: 5c42f981e9e54ae286b5ea5faf4dd29486c6350c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28kernel-dev: Added new requirement for working with yocto-linux-custom.bbScott Rifenbark
Fixes [YOCTO #6611] Added a new step to the "Working With Your Own Sources" section so that the user is aware of needing to provide a defconfig file or configuration fragments to the SRC_URI variable when working with the yocto-linux-custom.bb recipe. (From yocto-docs rev: dd25274979f689ae9135158279080add19a98393) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28documentation: Updated customization layers to point to XSL mirrorsScott Rifenbark
The customization layers were pointing to Sourceforge site for the XSl files needed to build the manuals. Throuhgout time, this site has failed me enough to warrent trying to get these XSL files from some other source. Rather than ship the XSL files with the YP release, we decided to create some mirrors and point the customization files there. (From yocto-docs rev: 4fd1703870694dff1f593b421f90aad0803d9e65) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28kernel-dev: Added new "in-tree" defconfig file section.Scott Rifenbark
I added the new section "Using an "In-Tree" defconfig File" section. This section addresses the ability to not use the default location for defconfig files, which is usually in the metadata layer. The section describes how to use the KBUILD_DEFCONFIG variable. Fixes [YOCTO #7474] (From yocto-docs rev: d68f7b47d974d94177b344247056778742f57786) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28kernel-dev: Added detail to start of generating config fileScott Rifenbark
Fixes [YOCTO #7474] The "Generating Configuration Files" section has a procedure that starts with a step to complete a build at least through the kernel configuration task. This is needed but we could use a bit of explanation here. I added some rationale behind why you should do this. (From yocto-docs rev: 63df3474f4ed211dd6b7d1cf4f4e90bbc92c2595) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-15documentation: Preparation for 1.9 buildsScott Rifenbark
This involves the following: * Inserting a new row for all manual revision history tables to have "October 2015" and 1.9 as the release information. * Updating the mega-manual.sed file to process links for 1.9 * Updating variables in poky.ent to deal with the 1.9 release variables. (From yocto-docs rev: 1ed55c08b96cf0fded38833635111a5c6da86781) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-01documentation: Updates to try to fix CentOS docs build errorsScott Rifenbark
The docs are not building on CentOS and we think it is due to the XSL templates being called for the Eclipse parts. I located all the "current" templates and switched them out for "1.76.1" version as are used by the mainstream doc builds. (From yocto-docs rev: afbddde6524630433dfec973bbe886de32395bc8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-03-19documentation: Updated Manual revision tables with "April 2015"Scott Rifenbark
(From yocto-docs rev: a012e34956b8ac2fa7610e264f460bc27bdd66d8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-03-10kernel-dev: Fixed missed shortcutRobert P. J. Day
(From yocto-docs rev: 3f9c25820bb93f8efb6eaf415e9d7a9545832a7c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-03-10kernel-dev: Updates to the "Using Kernel Metadata in a Recipe" section.Scott Rifenbark
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>
2015-03-10kernel-dev: Correct reference to "files" directory, should be ${PN}", and ↵Robert P. J. Day
update kernel version. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-03-06kernel-dev: Update name of build directoryRobert P. J. Day
Tweak the manual to refer to the name of the kernel build directory as it is listed precisely in linux-yocto.inc. (From yocto-docs rev: f8c762e42a67bd84b733a5ae2512581af805a76b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-03-06bsp-guide, kernel-dev, ref-manual: KERNEL_FEATURES should refer to .scc files.Robert P. J. Day
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>
2015-03-06kernel-dev: Applied some user-input formatting for some variables.Scott Rifenbark
(From yocto-docs rev: 2aa26a4f32268997e730d48626ad074ef9fcd8bf) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-03-06kernel-dev: Substituted "emenlow" example for "fri2"Scott Rifenbark
(From yocto-docs rev: 786f647bfb0aca98be64a5515c1cc3b645c85d3e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-03-06kernel-dev: Added quotes around a section cross-reference.Scott Rifenbark
(From yocto-docs rev: e8b4b8239c2d7ae6a5989e0f3ab82b25ccd34ae9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-03-06kernel-dev: Fixed variable formatting.Scott Rifenbark
(From yocto-docs rev: f2264bc3a61c284f01e68feea86858e46bf1594d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-03-06kernel-dev: Swapped out fri2 BSP for emenlow BSP in example.Scott Rifenbark
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>
2015-03-06kernel-dev: Updated "Modifying Source Code" section.Scott Rifenbark
Substituted a more correct build directory path in the example by providing "${WORKDIR}/linux-${PACKAGE_ARCH}-${LINUX_KERNEL_TYPE}-build" Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 818493d7ee5fc6c1750f20e5cea22a3816c8675c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-03-06kernel-dev: Scrubbed out the 3.4 kernel references.Scott Rifenbark
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>
2015-03-06kernel-dev: Minor typo fixed and added LTSI linkRobert P. J. Day
Fixed a small text issue where a hypen was needed. Also, provided a real link to the YP LTSI page. (From yocto-docs rev: aa8c06b79eef1855c3b5af4c8bfa47a96a86d332) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-03-06kernel-dev, ref-manual: Edits to KBRANCH.Scott Rifenbark
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>
2015-03-06kernel-dev, ref-manual: Scrubbed out the KBRANCH_DEFAULT variable.Scott Rifenbark
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>
2015-03-06kernel-dev: Clarify a couple minor things in kernel manual, ch 2.Robert P. J. Day
Some small changes to clarify how to change the configuration. (From yocto-docs rev: fce7c97abb69f15142dbadf90a90965a49ec3e0e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-27kernel-dev: Small fixes.Scott Rifenbark
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 198ce97a1158237056f035ade555ce04a6031c56) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-27kernel-dev: Updated FILESEXTRAPATHS example in 2.2.3.Scott Rifenbark
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 4d85a363602eeb8c5f52064af9ffa1a47e541470) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17documentation: Reverted back to the 1.76.1 XSL stylesheetScott Rifenbark
Using the 1.76.1 version in all the customization layers so the manual revision tables will build with boxes. (From yocto-docs rev: 85a31ef53a59d17bed23ebf57a14db507eb21338) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17documentation: First draft devtools.Scott Rifenbark
Completed draft of the new devtool material. This commit affects some linking and figures across the YP doc set. * Added the build-workspace-directory.png file to both the dev-manual and the mega-manual. * Updated the Makefile to include the new figure in the TARFILE for dev-manual and mega-manual. * Re-did the section organization to pull the quilt and finding source file out of the "Modifying Source Files" section. (From yocto-docs rev: 4585b9fbb1636ae3c65e2e3ad2d1d6baca636e59) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17documentation: Changed back to the "current" XSL style sheet.Scott Rifenbark
I need to get back to how it was working and then fix the table box issue from there. Using the 1.76.1 stylesheets makes the build too long for the manuals and sometimes the XSL sheets do not load. (From yocto-docs rev: 7bc502fa069fdc4aebf5705513bb82127716859f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-01-06documentation: Updated all XSL style sheet imports to use 1.76.1 versionScott Rifenbark
This fixes the issue where the lines for the manual revision table are not appearing. For some reason they do not appear when building the docs using Ubuntu 14.10 and the "current" XSL transformation files. So, I backed up to the 1.76.1 version, which is the nearest version where the issue does not surface. (From yocto-docs rev: 82b15986b97b9ed082b652b562eaaf843572fdff) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-11-04documentation: Updated the manual revision history tables.Scott Rifenbark
Added an entry for the 1.8 release stating that the release is slated for sometime in 2015. (From yocto-docs rev: 9799a7848f24024048eae0cbed470a2be4b4b879) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18kernel-dev: Scrubbed and fixed all user-supplied input formatting.Scott Rifenbark
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>
2014-10-03documentation: Updated release date for manual rev tables.Scott Rifenbark
Added "October 2014" to table for all manuals that have the table. (From yocto-docs rev: 3f9ceb4dd2397fe907bf701c842277eb65d11a56) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-23kernel-dev: Fixed a wording typo.Robert P. J. Day
(From yocto-docs rev: 204f48ae38d1504bcc560a5c611d09ac90f42c46) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21kernel-dev: Fixed typoRobert P. J. Day
(From yocto-docs rev: 3d7c0c814de076680ef7fdb42193f39b9947ae48) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21kernel-dev: Fixed link to BitBake command:Robert P. J. Day
Reported-by: Bill Traynor <btraynor@gmail.com> (From yocto-docs rev: 4bce72419c01e0c77969a56eb194ad7179b7ad80) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03documentation: Added permalink display styles to CSS files.Scott Rifenbark
Fixes [YOCTO #5772] Updated each manual's CSS style sheet to contain a style for how the permalink symbol looks on its own and how it looks when a user hovers over it with the mouse. (From yocto-docs rev: c8d4afa0b83a40ac2de0c47c191a11b3e7d241e5) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18kernel-dev: Edits to "Working with Out-of-Tree Modules"Scott Rifenbark
Fixes [YOCTO #3729] I made an editing pass through this section. Found some minor corrections. (From yocto-docs rev: 314ec3a066de7328b6c6893ce33cc0e5faa8700a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18dev-manual, kernel-dev: Provides some cross-reference to "clean" stuff.Scott Rifenbark
I scrubbed the manual set for appropriate places to reference into the do_clean* type tasks. Found and added several occurrences. (From yocto-docs rev: 01594823b1d556bc70e928af1838039cc15a816d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>