summaryrefslogtreecommitdiffstats
path: root/documentation/bsp-guide
AgeCommit message (Collapse)Author
2012-09-04documentation: Title changesScott Rifenbark
Removed "The" from all the titles of the books. This makes it easier to reference to them and easier for the automated processing of the mega-manual. (From yocto-docs rev: af566d6d007cff642648698ea487a6eeaa8cc930) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation: Manual reference fixes for mega-manual processingScott Rifenbark
I fixed several occurences of cross-references to whole manuals where the formatting was split in the <ulink> statement. The <ulink> tag and the manual title must be on one DocBook line in order for the sed scripts to correctly process the links when the mega-manual is created. (From yocto-docs rev: 0dee12d518c892f59c0446e1c7b5d0f71b6ee22b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation/bsp-guide/bsp-guide.xml: Fixed titleScott Rifenbark
the title in the note about production process was technically wrong. I added in "Yocto Project" as part of the title. (From yocto-docs rev: c421f02549b8ca203d1c9f747870911c59bda96c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation: Fixes to note for mega-manual processingScott Rifenbark
the notes that say "Due to production processes..." at the start of each manual contain links to manuals. the links needed to be formatted such that the entire <ulink> code and manual name appeared on the same line so that the sed script can effectively remove the link in the resulting mega-manual. (From yocto-docs rev: 0a41971c331ad1961e6ee1e067b59c36c9f048f6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation: Fixed references to the YP Dev ManualScott Rifenbark
The references to the YP Development Manual were inconsistant. These references were fixed. (From yocto-docs rev: f4ded0b965fcbce7b500ca21886ee9b755c38383) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04documentation: Style sheet naming changesScott Rifenbark
I had to rename individual style.css sheets to have book-specific names. So style.css for the ADT manual becomes adt-style.css and so forth. Turns out, this isn't really necessary for the solution to create the mega-manual but I am leaving the changes as a separate commit because it makes sense. It causes no disruption to making the six YP manuals. (From yocto-docs rev: 8cbdae1fe86988243f91dfd611c14f8a37007886) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-26documentation/bsp-guide/bsp.xml: Fixed error in sample layer.conf file.Robert P. J. Day
(From yocto-docs rev: 9ea6fc5d2b9ede51668121421e448f9fffc7e7de) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-24documentation: Updated the h6 style to use a larger fontScott Rifenbark
(From yocto-docs rev: 5fa8d627fe671f0eb7bbc67ce852e2010cbd723f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-22documentation: Created cross-references to new KMACHINE glossary itemScott Rifenbark
With the creation of a new KMACHINE glossary item, there were two areas in the YP doc set that reference the variable. I added cross-reference tags. Also noted that some other references were missing to the variable COMPATIBLE_MACHINE. (From yocto-docs rev: f740b62be175a50f17ce8a244258dcf391fcf672) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-20documentation: Config fragment sections updatedScott Rifenbark
I have updated both the section for configuration fragments found in the BSP and dev manuals. Reported-by: James Abernathy <jabernathy@gmail.com> (From yocto-docs rev: 62f4df751c80e7b749356bb80ade3a7847411f7c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation/bsp-guide/bsp.xml: Updates to Kernel configuration sectionScott Rifenbark
final changes to the section that talks about configuring the kernel. Changes here based off Bruce Ashfield's review comments. (From yocto-docs rev: 7715643f2a24336585dd44d1d75e7be0aade7f6b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation/bsp-guide/bsp.xml: Changes to kernel config section.Scott Rifenbark
Some work in progress. (From yocto-docs rev: d344b2db75c21bc7050e4a5f70c07ffd8f7545de) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-09documentation/bsp-guide/bsp.xml: Fixed referece to source directoryScott Rifenbark
I missed a "Yocto Project Files" term because the damn thing split across two lines in the source file and my grep method did not find it. Changed it to "source directory." (From yocto-docs rev: 31a261c141d3e26f4a87b9725097005c96345e2e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-02documentation/bsp-guide/bsp.xml: Yocto term paringScott Rifenbark
Pared down the use of the term Yocto Project. (From yocto-docs rev: d62747ca1d42cae703d1cd307dfe16bb9682b741) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-06-15documentation/bsp-guide/bsp.xml: Review comments to recommendationsScott Rifenbark
I added a small review comment to the section based on reviewer feedback. (From yocto-docs rev: 68cc2bac8dca78572d197af326452bbd37c947f9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-06-15documentation/bsp-guide/bsp.xml: Added note to BSP recommendationsScott Rifenbark
Inserted a note warning the developer that it is their responsibility to understand and meet all licensing requirements if they are going to be including images as part of a BSP. (From yocto-docs rev: b8154904be02a4185bf417f193eb125b8470bc8d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-06-15documentation/bsp-guide/bsp.xml: Updates to requirements sectionScott Rifenbark
Implemented review feedback from Dave Stewart and Tom Zanussi. (From yocto-docs rev: 5ed73c29b6a46737a009a38b294bdd61e4c63d85) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-06-15documentation/bsp-guide/bsp.xml: BSP recommendations section addedScott Rifenbark
Added the "Requirements and Recommendations for Released BSPs" section. This section was requested by Dave Stewart based on community input for direction on how to create a BSP that was compliant with the Yocto Project. The input for the section came from Tom Zanussi. A spell-check was performed also prior to this commit that addressed a few spelling issues across the file. (From yocto-docs rev: 7ed0dd1093b33491231dec06f7b5f8e76004130d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-05-31documentation: Added manual history for 1.3Scott Rifenbark
Added entries for the Manual History table for upcoming 1.3 docs. (From yocto-docs rev: 430b384035593cd05c4f286e20c01f0fe72da8ec) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-23documentation: Updated Manual Revision Tables again.Scott Rifenbark
After some discussion from Song and Richard, the dates in the manual revision table has been updated to "April 2012" for the 1.2 release. (From yocto-docs rev: b3fc2ec7c5aedb8ea0a2d502bdcd7e8f4092ed96) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-23documentation: Manual Revision Tables updatedScott Rifenbark
Five tables updated for the five manuals that have the tables. Used "May 2012" as the date. (From yocto-docs rev: 0d4d46ba300c07ff9c73186506be5b409bef9d1b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-18documentation/bsp-guide/bsp.xml: spelling corrected.Scott Rifenbark
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: c0ee8ce391114f7a5b4f1c59fdf997ba4f3bcf75) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-10documentation/bsp-guide/bsp.xml: Added a info about meta-intel layerScott Rifenbark
I put a bit of explanation in the "BSP Layers" section about meta-intel being a layer that in fact contains other BSP layers. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: c57ba6050d7923018709221f7058443293ea6838) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-10documentation/bsp-guide/bsp.xml: Edits to intro sectionsScott Rifenbark
Adding the new section "Customizing a Recipe for a BSP" has added enough sections to this book such that the introductory area needed some attention. I pared down the intro text to basically just cover the manual's organization and a bit about BSPs. I moved all the introductory common form stuff into the section that just addresses the BSP form. This is better organization for the manual as it is evolving. (From yocto-docs rev: 9aec4ce47fb090ae2f6c5bed93da03e77ae49a4c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-10documentation/bsp-guide/bsp.xml: Added new sectionScott Rifenbark
Fixes [YOCTO #1962] Added a new section called "Customizing a Recipe for a BSP". The text was rooted in Darren Hart's comments. I implemented them and then we iterated a bit on it. Reported-by: Joshua Lock <joshua.lock@intel.com> (From yocto-docs rev: f5e51d60312d9335a790023f193cae1ba76277ae) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-04documentation/bsp-guide/bsp.xml: Patch to fix small issuesRobert P. J. Day
Applied a patch from Robert P. J. Day to fix some small issues in the BSP manual. (From yocto-docs rev: 7744d5101fd2b5a46a53707976b8899eb03f1c08) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-03documentation/bsp-guide/bsp.xml: Added some front-matterScott Rifenbark
Due to the addition of the BSP Tools section, I needed to add a bit of front-matter to the start of the chapter indicating that we provide information on how to create and manage a BSP Layer. (From yocto-docs rev: 7ae34fa58aba6b17866a5379bdcdffd83491ff20) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-03documentation/bsp-guide/bsp.xml: Removed NoteTom Zanussi
Remove the 'note' that says that the BSP Guide doesn't show how to create a new BSP. With the addition of the Yocto BSP Tools section, that's no longer true. Also, the wiki page mentioned is out-of-date and probably shouldn't be pointed to any longer for that reason. (From yocto-docs rev: 972c2d2bc9f50f5f65b296b7396dc640710ad5b2) Signed-off-by: Tom Zanussi <tom.zanussi@intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-03documentation/bsp-guide/bsp.xml: Edits to the BSP Tools sectionScott Rifenbark
I have scrubbed the new section for the BSP Tools. Changes reflect re-wordings, formatting, etc. (From yocto-docs rev: c13d5a42665d256c6da6d663611291eef9617f1f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-03documentation/bsp-guide/bsp.xml: New section on using BSP tools.Tom Zanussi
Some documentation introducing and helping get people started with the Yocto BSP Tools (yocto-bsp and yocto-kernel). (From yocto-docs rev: 56a6db181f5cdf3c23daa021fe1e9ecb15843678) Signed-off-by: Tom Zanussi <tom.zanussi@intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-28documentation: Added TBD entry to 1.2 manual history table.Scott Rifenbark
There needed to be an entry in all the manual history tables that indicated this version of the manual is for 1.2 but is WIP. Reported-by: Rudolf Streif <rudolf.streif@linux.com> (From yocto-docs rev: 6792b88af4f0171cfc84e4d77bda871d4af3d36c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-26documentation/bsp-guide/bsp.xml: README file not optionalTom Zanussi
Any shipped BSP needs this file for legal reasons, thus it's non-optional. (From yocto-docs rev: 4840f9a9d6b62f61378941c9a8712eb36720efd8) Signed-off-by: Tom Zanussi <tom.zanussi@intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-26documentation/bsp-guide/bsp.xml: Readme description editsTom Zanussi
The README section should not be optional, since at minumum it needs to contain layer dependencies and maintainer info. (From yocto-docs rev: 0bb2e8baf9ca7b4f1b8d8c08b4901d1f4312b270) Signed-off-by: Tom Zanussi <tom.zanussi@intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-26documentation/bsp-guide/bsp.xml: Removal of certain layersTom Zanussi
Wording changed to remove example BSP layers that really weren't layers (e.g. meta-intel). One of three patches from Tom. Reported-by Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 84677e0ef26f48af9b45585224d6c4dee0406f5e) Signed-off-by: Tom Zanussi <tom.zanussi> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-23documentation: Updated all style sheets for down-sized notes.Scott Rifenbark
(From yocto-docs rev: c4188d6daa81d8309ba71c5b9c3dde5b10ea730e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-23documentation/bsp-guide/bsp.xml: Edits to BSP Licensing sectionScott Rifenbark
Grammar, style, and formatting edits applied to the "BSP Licensing Considerations" section. (From yocto-docs rev: 9809e0b5081bdc4f27d7d949930c409575a9a083) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-23documentation/bsp-guide/bsp.xml: Patch applied for LicensingTom Zanussi
"The LICENSE_FLAGS mechanism can now be used to meet the special license requirements needed by some BSPs. Update the documentation to reflect the current BSP licensing mechanisms. Also add a new blurb about the time-limited kernel." - Tom Zanussi I applied this patch verbatim and will check and clean up text as needed. (From yocto-docs rev: d05a7ddbc0d6017e5a8be2b3e0117f53e30a204b) Signed-off-by: Tom Zanussi <tom.zanussi@intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-23documentation: Updates for [YOCTO #1717].Scott Rifenbark
Minor edits to the BSP Guide, the Development Manual, and the Kernel Manual to address [YOCTO #1717], which noted confusion over the kernel manual when a user was trying to find kernel configuration information. The fix for this bug involved several areas. I had previously created a new section called "Kernel Configuration" in the kernel manual and "Configuring the Kernel" in the YP Development manual. There were several rounds of feedback from Bruce Ashfield. This commit represents the final touches on the three manuals to address the bug. Fixes [YOCTO #1717] (From yocto-docs rev: de8f85753ad1d6dde66adb6bb4cb09e9528c7cd6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-23documentation/bsp-guide: Converted links to use poky.ent variables.Scott Rifenbark
(From yocto-docs rev: 5a95fd07deed0c118529b7890857850308b4b5ab) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08documentation: Updated copyright notices to 2012.Scott Rifenbark
(From yocto-docs rev: a270fe40606ccbef5c453bb77f009306a7bdfb93) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08documentation: Section change and cross-reference fixesScott Rifenbark
I renamed the "BitBake Layers" section in the YP Development Manual to "Understanding and Creating Layers." Renaming the section broke three cross-references in the YP documentation manual set. I applied fixes to the references. (From yocto-docs rev: 93f4f5dfb61ed48047a40f5bbbc3f5e844c7c2f4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08documentation/dev-manual: Added anchor point and edits to kernel configScott Rifenbark
I added a reference anchor to the spot in the dev-manual for the "Yocto Project Source Repositories". Other changes were to the bsp guide and were general edits to the "Linux Kernel Configuration" section. (From yocto-docs rev: def35923199d48c879ff06a68f81b5cd28d55185) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08documentation/bsp-guide/bsp.xml: Edits to Misc Recipe FilesScott Rifenbark
I added a bit more to the note about BSPs that do not have a formfactor entry. The note was vague. Explanation provided by Tom Zanussi. (From yocto-docs rev: 997832850cf01d83bf3b799a5a6e7f5c902d9a8f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08documentation: Edits to all style.css filesScott Rifenbark
Updated all the CSS style sheets so that the Note, Warning, Tips, Caution, etc. boxes are not so prominant. (From yocto-docs rev: 451568553e9620c1e247c2f67b0665b184c3300b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08documentation/bsp-guide/bsp.xml: Edits to Display Support Files SectionScott Rifenbark
(From yocto-docs rev: c888c1c82dea615175bdb8818409a264d0c749ee) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08documentation/bsp-guide/bsp.xml: Edits to Core Recipe Files section.Scott Rifenbark
(From yocto-docs rev: 8bd330a4d43732a10c4801f27a969adc83ac0e97) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08documentation/bsp-guide/bsp.xml: Edits to HW Configuration Options SectionScott Rifenbark
Made some minor edits. I also discovered that the information describing where tuning files reside was not real helpful. In particular, tuning files are not limited to the meta/conf/machine/include directory. For example, the Crown Bay BSP layer includes a tuning file from the meta-intel Layer. (From yocto-docs rev: 3a76ccc4f645f03a6e888b7eb53fa9bc7bfb255e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08documentation/bsp-guide/bsp.xml: Edits to "Layer Configuration File" section.Scott Rifenbark
(From yocto-docs rev: 78d36baa57fe9c95bdd39eb63a5bada6a1a5ee64) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08documentation/bsp-guide/bsp.xml: Edits to pre-built user binaries section.Scott Rifenbark
(From yocto-docs rev: 1bf460e980ee35e783a64de2cddfdd68c5471871) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08documentation/bsp-guide/bsp.xml: New "README.sources File" section added.Scott Rifenbark
(From yocto-docs rev: 2f398b278904b26e4cd6ab237c0c9dce7e8d6009) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>