aboutsummaryrefslogtreecommitdiffstats
path: root/documentation/kernel-dev
AgeCommit message (Collapse)Author
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>
2014-06-18documentation: Updated style sheets to remove unused .PNG files.Scott Rifenbark
Fixes [YOCTO #6430] The style sheets were carrying over old .PNG files that are not part of the manuals. I have removed the statements that were using them. (From yocto-docs rev: 6e4fa419b9367ab5e34b9aa8010a24980416dc7d) 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, ref-manual: Updated task name usage.Scott Rifenbark
There was inconsistency on how we refer to a task name throughout the YP manual set. The proper way is "do_<taskname>". Some occurrences did not include the "do_" prefix. These have been fixed. (From yocto-docs rev: b32821bb0d3e6de7bca68b25c662a023526a10c4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18kernel-dev: Updated some TOC generation XSL parameters.Scott Rifenbark
Restoration of some parameters to make sure the TOC is generated correctly. (From yocto-docs rev: 0f4c4b526fd0e8c3cce3fc033c660112e5dc517f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18kernel-dev: Added an embedded section.Scott Rifenbark
Not having a section was messing up the TOC for the FAQ in the mega-manual. I added a section. (From yocto-docs rev: d4a34cb1815e3e12e73e08b5ae7b2027b5f03823) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18kernel-dev: Added XSL templates to support permalinks.Scott Rifenbark
Fixes [YOCTO #5772] (From yocto-docs rev: 4c5fb40e07b0ede7969922de36e394897d0684f4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18kernel-dev: Added new "Building Out-of-Tree Modules on the Target" section.Scott Rifenbark
Fixes [YOCTO #3729] I have made an attempt at understanding this and creating a section that describes the steps the user needs to take in order to build out-of-tree modules on the target device when running an SDK image. I created a new section called "Building Out-of-Tree Modules on the Target". Basically, the user needs to be on the target and change to a directory and then create some scripts before attempting to build these types of modules on the target. (From yocto-docs rev: e0754ae6dbc5dc07fb6707fe4b71ecd95c8180dc) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-13kernel-dev: Added a link to the do_compile task.Scott Rifenbark
There was an occurrence of the do_compile task mentioned in the manual. I have added a cross-reference link from it to the new section in the ref-manual. (From yocto-docs rev: 0981ca8ca9856063d4daeaae155aabdfd1c7dcc8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-13documentation: Updated the manual revision history tables for 1.7Scott Rifenbark
(From yocto-docs rev: 9014fe95b9607a15c0e72ef1b6df14f250a3d241) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-21documentation: Updated all the manual revision history tables.Scott Rifenbark
Set the release date to April 2014. (From yocto-docs rev: 2592bc968edeea941a92e6bdd321dd872745b78c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-08dev-manual, kernel-dev: Replaced routerstationpro with edgerouter.Scott Rifenbark
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>
2014-03-30bsp-guide, kernel-dev: Added Cross-references to "BitBake" termScott Rifenbark
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>
2014-03-25kernel-dev: New step to "Generating Configuration Files" section.João Henrique Ferreira de Freitas
Add a new step about how to use diffconfig task to create kernel config fragments. Scott fixed some grammar in one of the sentences after applying the patch. (From yocto-docs rev: 5b7ccdbf708cbeebc2d8dc91db129fb35aabdcdd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-25documentation: Fixed "Relased date" for the 1.5.1 entryScott Rifenbark
Fixes [YOCTO #5857] I had missed replacing the release date in the manual revision history tables for the 1.5.1 release. It was still an estimate. I have replaced with the actual date of "January 2014" (From yocto-docs rev: fb9abe0df33a9b551d797ac1b72577931f5f8ce6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03documentation: Scrubbed use of directory namesScott Rifenbark
There was inconsistent use of the way directory names were handled throughout the YP documentation. I have scrubbed the set and replaced many instances such as the following: meta/<something> replaces /meta/<something> poky replaces ~/poky (except in some very specific examples) I basically got rid of leading slash characters. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: ae2e451ed8f61484d04b30017021912c4493a441) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-01documentation: Changed Note for most recent manualScott Rifenbark
Fixes [YOCTO #5368] Changes partially address this issue, which is the removal of tarball installations for poky. The notes at the beginning of the YP manuals suggested that the tarball version of a manual might lag the version found on the website. Because we are discouraging installing poky/documentation from a tarball now, I have re-written the note to be generic and suggest simply that for the most recent version of the manual associated with the release, see the manual on the website. (From yocto-docs rev: a5e96e7eb719e69bbcf2139af2e20230aedc4247) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-01kernel-dev: Corrected error in the FILESEXTRAPATHS exampleRobert P. J. Day
FILESEXTRAPATHS_prepend example is missing essential trailing colon. (From yocto-docs rev: 6287fee9fba7173cdd22fc9bbd4378367c75627f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-01documentation: Updates to Manual revision tablesScott Rifenbark
Updated all six tables for both 1.5.1 and 1.6 releases. Both entries need to ultimately be in the 1.6 version of the manuals. (From yocto-docs rev: ac1d2cc5686da142562cd674f7fa8908895a27df) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-10-01documentation: Updated Manual Revision History TablesScott Rifenbark
Placed the release month of October in for the 1.5 release. (From yocto-docs rev: c0431b2b3115d9687dcb5d3ba37adf6bf4695867) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-22kernel-dev: Updated the in-tree metadata sectionScott Rifenbark
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>
2013-08-13kernel-dev: Fixed link in title page to point to new manual.Scott Rifenbark
The stock Note indicating that the user should consult the website for the latest version of the released manual had a link to the old kernel-manual. I have replaced it with a link to kernel-dev. (From yocto-docs rev: 804e672e42a66aecdbe83ce239433216af10ef8c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-31dev-manual, kernel-manual: Added links to THISDIR variableScott Rifenbark
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>
2013-05-22kernel-dev: Updates to "Creating the Append File" section.Scott Rifenbark
Pointed out by Robert P. J. Day that I was using the wrong FILESEXTRAPATHS example for an append file. I failed to include the "_prepend" part of the variable. Also, the wording based on the example made some assumptions and was not entirely accurate. The changes I put in made the section very specific. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 659c5a9c41a92f469ea0ea3630e11b4ba2df8f56) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22kernel-dev: Updated changing the configuration section.Scott Rifenbark
Robert P. J. Day pointed out some implied meanings in this section that indicate configurations from .config are exclusive somehow from configurations applied through config fragments. That is not the case. I have inserted a note to clear up that implied meaning. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 5ac27e8a2aea662a8e70dda0e852b5ea401b8b00) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22documentation: Updates to properly build the 1.5 manualsScott Rifenbark
1. Changed the variables in poky.ent to contain the "1.5" string and the "tbd" string for the unknowns. 2. Updated the manual revision history tables so to replace the 1.4.1 release entry, which should not be there, to the 1.5 entry. (From yocto-docs rev: d03a09875b1fe0d244b7a7c1bde718319d95a8ab) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22documentation: Set up the 1.4.1 manual set.Scott Rifenbark
1. Edited poky.ent to have 1.4.1 and 9.0.1 for release stuff. 2. Updated the manual revision tables to have a new entry for 1.4.1 release. (From yocto-docs rev: bd4058b98f93ea5fd5d878f24018ce78b8ce1a53) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17kernel-dev: Edits to the "Changing the Configuration" section.Scott Rifenbark
This section had some problems. It failed to mention the need to extend FILESPATH by using FILESEXTRAPATHS. (From yocto-docs rev: e627cf21242a62fb23e93fdae61e8cfce32082a9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17kernel-dev: Fixed another occurrence of ${FILES}Scott Rifenbark
Further down in the section, a second occurrence of ${FILES} needed changed. (From yocto-docs rev: 0212a1ebfef4c5a6a0ae76410f7753bbc41d3e82) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17kernel-dev: Correction to where to place a .cfg file.Scott Rifenbark
This was inaccurately referencing the ${FILES} directory when it should be talking about a "files" directory created in the user's layer where the kernel .bbappend file resides. (From yocto-docs rev: 2af3a71db6e6d99b9aa4b710e21f3f3bacff0b82) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17kernel-dev: Spell checked the files and fixed appropriately.Scott Rifenbark
(From yocto-docs rev: 0b9510d009f6437179c3848fc14c94af07ab99e2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17kernel-dev: Removed a reference to sections that no longer exist.Scott Rifenbark
(From yocto-docs rev: ec1c1e7dea0012cf378a572c399b928a410974fb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17kernel-dev: Inserted a cross-link to the term Build Directory.Scott Rifenbark
(From yocto-docs rev: bdd82d8681272f342e78b9df222b3b5f1682ed33) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17kernel-dev: Removed the <word>/<word> construction.Scott Rifenbark
(From yocto-docs rev: b910a33f2e4179b08ce6283272d7d25e7ba89613) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17kernel-dev: Removed another "don't" contraction.Scott Rifenbark
(From yocto-docs rev: 1d839d54b914a54747afd965f93bb4a6d08d5fac) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17kernel-dev: Removed a development note that was for Bruce Ashfield.Scott Rifenbark
(From yocto-docs rev: e78c2bd1ac07dbe7344e4bb0a6089f1bee7ea5ad) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17kernel-dev: Removed the "don't" contraction.Scott Rifenbark
(From yocto-docs rev: 8e95cfe286de36d2beace01fd885e220f4044aeb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17kernel-dev: Eliminated a redundant paragraph.Scott Rifenbark
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>
2013-04-17kernel-dev: Fixed a broken link to a cross-section.Scott Rifenbark
(From yocto-docs rev: 2287d83cc8c03e1de8c2d4a36ba73fc6cc24ce55) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17dev-manual, kernel-dev: Edits for changing a section head title.Scott Rifenbark
Re-worded the title for "Set Up Your Layer for the Build." This resulted in a lone link from the kernel-dev manual changing. (From yocto-docs rev: bf797a9ad4b40ded6bd3b4dc8cc3d8ac702f05a6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-10documentation: Updated the release month to April in manual history tables.Scott Rifenbark
(From yocto-docs rev: 3dc4e3db0a76a29c9726d38e3f862940437317c9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04kernel-dev: Commented out some development notes to Darren.Scott Rifenbark
(From yocto-docs rev: 9981e5d85751eb6f21b1c06390158a995d7f59a8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14documentation: Part 2 of 2 for YP doc integration into Eclipse.Timo Mueller
This commit adds the three *.customization.xsl files. I (Scott Rifenbark). Split the commit because after applying the 18 patches, the list of stuff to stage was huge and I did not want to add them one-by-one. So I staged them using git add -u. Here is the general cover letter information from Timo included with the 18 patches: ----------------- Hi, the generation of eclipse help files has been merged from the timo branch to the master. Since the creation of the timo branch there have been some changes to the master branch (e.g. new documentation, renamed documentation). This patch set does some cleanup for the renamed documentation and adds eclipse help generation support to the new documentation. 01: Removes the 'the' from the document titles 02..04: Cleanup obsolete artifacts resulting from the merge 05..08: Add eclipse help generation for ref-manual 09..13: Add eclipse help generation for kernel-dev 14..18: Add eclipse help generation for profile-manual Best regards, Timo (From yocto-docs rev: eff391a17d0a2403634adfb2f4cd2ff50ad0b771) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14documentation: Part 1 of 2 updates to integrating docs to Eclipse help.Timo Mueller
Hi, the generation of eclipse help files has been merged from the timo branch to the master. Since the creation of the timo branch there have been some changes to the master branch (e.g. new documentation, renamed documentation). This patch set does some cleanup for the renamed documentation and adds eclipse help generation support to the new documentation. 01: Removes the 'the' from the document titles 02..04: Cleanup obsolete artifacts resulting from the merge 05..08: Add eclipse help generation for ref-manual 09..13: Add eclipse help generation for kernel-dev 14..18: Add eclipse help generation for profile-manual Best regards, Timo This patch set originally contained 18 patches. I (Scott Rifenbark) had to push these changes as two parts. This is the first part. It does not include creation of the three cusomization files. (From yocto-docs rev: 9b1889f6e31ee70dae704fa08763fb9196616dad) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14kernel-dev: Added note for YP release requirements.Scott Rifenbark
The user needs to have YP 1.2.2 release or forward for the examples in the book to work. I have added a note indicating such. (From yocto-docs rev: 6fcbd3f526a13ef632c7ce5b9b4774d166b61895) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-30kernel-dev: Added "-dirty String" section.Scott Rifenbark
The "-dirty" String section from the old YP Kernel Architecture and Use Manual was moved to section 2.3 of the manual. It needs to find the right area to be put in (AR for Darren). I added the AR text to the top of the section so it would not fall through the cracks. (From yocto-docs rev: eaa5b86643572a6c74028dc3330625a0bfbca50e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>