summaryrefslogtreecommitdiff
path: root/documentation/bsp-guide
Commit message (Collapse)AuthorAgeFilesLines
* documentation: BSP Developer's Guide fixesTom Zanussi2011-03-141-11/+11
| | | | | | | | - use linux-yocto instead of linux-yocto-stable in examples - change branch names to match linux-yocto usage - remove outdated 'wrs' where it appears Signed-off-by: Tom Zanussi <tom.zanussi@intel.com>
* documentation/bsp-guide/bsp-guide.xml: Updated revision history on title page.Scott Rifenbark2011-03-021-1/+6
| | | | | | | | | I updated the revision history on the title page to reflect the upcoming Release 1.0. I will likely have to change this as we get nearer the release so I can be sure of the number and also add meaning release remarks to the entry. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp-guide.xml: Updated RP email addressScott Rifenbark2011-03-021-1/+1
| | | | | | | Changed the email address for Richard Purdie in the author title page to richard.purdie@linuxfoundation.org. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* [BUGID# 695] - documentation/bsp-guide/figures/bsp-title.png: Updated title ↵Scott Rifenbark2011-03-021-0/+0
| | | | | | | | | | | | | graphic [BUGID# 695] - I updated the title to use a less bold and intrusive font and one that is still common for systems. Also removed the "s" in the title so it now reads "Board Support Package (BSP) Developer's Guide." I also put a better looking Yocto logo in. Once this commit is merged bug #695 can be marked resolved. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* [BUGID# 553] - documentation/bsp-guide/bsp.xml: Re-write of click-throughScott Rifenbark2011-03-021-25/+34
| | | | | | | | | | | | | | | | | | | [BUGID# 553] - In the 'BSP Click-Through Licensing Procedure' section, which is shared between the BSP Guide and the Poky Reference Manual, there were three links to 'pokylinux.org' sites. These links were intended to help a user get a license for encumbered BSPs. However, the links never did work. The section also had some wording that described a propsed naming convention for BSP tarballs that were encumbered and non-encumbered. The naming convention is a good idea but has not been followed so far. I removed the links and replaced them with general instructions on how to get through the licensing situation. Also removed the hard-line naming rules and replaces with a more general explanation of how we are naming BSP (e.g. Crown Bay). Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp-guide.xml: Updated copyrightScott Rifenbark2011-03-011-1/+1
| | | | | | Changed copyright date from "2010" to "2010-2011" Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp.xml: fix typo in variable namePaul Eggleton2011-01-201-1/+1
| | | | | | FILESEXTRAPATH -> FILESEXTRAPATHS Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
* documentation/bsp-guide/bsp.xml: Commented out three sections.Scott Rifenbark2011-01-061-1/+1
| | | | | | | | | There are some sections now that don't correspond one-to-one with the standard file structure presented in section 1.1. So I am commenting them out for now. Since I am still in the process of iterating on this manual I don't want to just delete the information. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp.xml: Spell checked the file.Scott Rifenbark2010-12-211-5/+5
| | | | Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp.xml: Updated Linux Kernel Configuration section.Scott Rifenbark2010-12-211-6/+11
| | | | | | Another round of feedback from Tom Z applied. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp.xml: replaced the append file line in the templateScott Rifenbark2010-12-211-1/+1
| | | | | | | | Section 1.1 has the example filesystem layout. The last line of the example filesystem layout had linux-wrs. It has been changed to linux-yocto-stable. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp.xml: Updated the Linux Kernel Configuration sectionScott Rifenbark2010-12-211-26/+63
| | | | | | These changes are another round of edits from Tom Z. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp.xml: Added reference to Kernel documentation.Scott Rifenbark2010-12-211-1/+3
| | | | | | | | | | | I added a reference to the specific section in the kernel documentation that describes how to create a BSP Based on an existing similar BSP. The tools we have that create the PDF manuals from the DocBook XML do not support cross-referencing to another PDF manual. So, I was left with adding a clunky text-based reference to the section and a link to the docs page on the web-site. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp.xml: Updated Linux Kernel Configuration section.Scott Rifenbark2010-12-211-29/+40
| | | | | | | I have re-written this section extensively based on a phone call with Tom Z. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp.xml: Updated Display Support Files section.Scott Rifenbark2010-12-211-1/+2
| | | | | | | Added wording to indicate this directory as optional if the BSP had special requirements for graphics support. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guild/bsp.xml: Updated Miscellaneous Recipe Files sectionScott Rifenbark2010-12-211-2/+7
| | | | | | | | | Found a mis-spelling that I corrected. Also added wording to indicate this directory is optional. Put in a note telling that defaults are set if a formfactor is not found. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp.xml: Updated Layer Configuration File SectionScott Rifenbark2010-12-211-1/+3
| | | | | | | Added wording to be sure user knows to replace "bsp" and "_bsp" in the boilerplate template example with the actual BSP name (i.e. <bsp_name>). Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp.xml: Changed numbering scheme.Scott Rifenbark2010-12-211-24/+23
| | | | | | | | | It makes more sense to have the sections that describe the various parts of the common structure as sub-sections to that. That pulls out the click-through licensing into a higher-level section. This is better overall section organization. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp.xml: Commented out three sections.Scott Rifenbark2010-12-211-2/+2
| | | | | | | | | There are some sections now that don't correspond one-to-one with the standard file structure presented in section 1.1. So I am commenting them out for now. Since I am still in the process of iterating on this manual I don't want to just delete the information. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp.xml: Updated Linux Kernel Configuration section.Scott Rifenbark2010-12-211-3/+6
| | | | Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp.xml: Added a Display Support Files section.Scott Rifenbark2010-12-211-0/+24
| | | | Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp.xml: Removed the recipes-bsp/formfactor ↵Scott Rifenbark2010-12-211-1/+0
| | | | | | directory from the common structure. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp.xml: Added a Miscellaneous Recipe Files sectionScott Rifenbark2010-12-211-0/+18
| | | | Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp.xml: Updated the Hardware Configuration Options ↵Scott Rifenbark2010-12-211-7/+6
| | | | | | | | section I combined the tuning stuff into this section. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documenation/bsp-guide/bsp.xml: Updated the Layer Configuration File section.Scott Rifenbark2010-12-211-3/+5
| | | | Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp.xml: Updated the Pre-built User Binaries section.Scott Rifenbark2010-12-211-4/+10
| | | | Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp.xml: Added the README section.Scott Rifenbark2010-12-211-0/+19
| | | | Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp.xml: Added new "License Files" section.Scott Rifenbark2010-12-211-0/+19
| | | | Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp.xml: Updated the introductary paragraph to the ↵Scott Rifenbark2010-12-211-1/+1
| | | | | | sections. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-work/bsp.xml: Added crownbay BSP example to section 1.1.Scott Rifenbark2010-12-211-0/+24
| | | | Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp.xml: Updated common form for file structure.Scott Rifenbark2010-12-211-12/+8
| | | | Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp.xml: Inserted text before the file structure ↵Scott Rifenbark2010-12-211-6/+4
| | | | | | | | | example Added some text in section 1.1 explaining that the file structure example is an example and that the file structure of specific BSPs could differ. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp.xml: Created better BSP example base namesScott Rifenbark2010-12-211-2/+2
| | | | | | | | Lowered the "E" for the "meta-emenlow" BSP. Removed the "oaktrail" one, which is an Intel code name and replaced it with "beagleboard", which is a non-Intel board. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp.xml: Added information about /binaryScott Rifenbark2010-12-211-1/+3
| | | | | | | | | Added information in the section about Pre-built User Binaries. In the first paragraph I stated that this directory would contain the Application Development Toolkit and minimal live images when the BSP is "tarred" up and placed on the Yocto Project website. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp.xml: Fixed typoScott Rifenbark2010-12-211-1/+1
| | | | | | | | Two lines had been earlier turned into a single sentence but the capitalization of the second line still remained. I switched "The" into "the". Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp.xml: Added note qualifying BSP file structure.Scott Rifenbark2010-12-211-0/+5
| | | | | | | Inserted a note that states the BSP file structure shown is an example only and that a given BSP could have different files. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp.xml: Changed meta naming conventionScott Rifenbark2010-12-211-3/+3
| | | | | | | Replaced meta-<bsp_name>/recipes-<bsp_name> with meta-<bsp_name>/recipes-bsp. This conforms to how the BSP standard will be working. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/bsp-guide/bsp.xml: General edits.Scott Rifenbark2010-12-141-94/+91
| | | | | | | | | | | | | 1. Edited to incorporate new file system naming structure per Saul Wold. This is the version I am sending him and Tom Z. to review. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Conflicts: documentation/bsp-guide/bsp.xml Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* bsp-guide: correct BBPATH exampleDarren Hart2010-12-141-1/+1
| | | | | | The BBPATH example was missing a : to separate the path elements. Signed-off-by: Darren Hart <dvhart@linux.intel.com>
* BSP Guide and BSP Chapter: Sync'ed these two filesScott Rifenbark2010-12-101-1/+1
| | | | | | | | | | | | | | After moving BSP Guide into its own folder for documentation I discovered a consequence of that. There are two separate bsp.xml files now: one in the poky-ref-manual folder and one in the bsp folder. I had done some good cleanup work in the version in the poky-ref-manual folder. This commit reflects a 'meld' operation where I re-sync'ed the bsp.xml file in the bsp-guide folder to be the same (almost) as the one in the poky-ref-manual folder. There is still one slight difference between the two files due to one's context as a stand-alone manual and the other as a section in a larger book. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* BSP Developers Guide: Edits to textScott Rifenbark2010-12-101-2/+2
| | | | | | | I made several spelling corrections and rewrote a sentence or two for better structure. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* BSP Guide and BSP Chapter in Poky Reference Manual: Changed wordingScott Rifenbark2010-11-151-1/+2
| | | | | | | | I created wording in the second paragraph of this file so that it can fit both the context of the BSP Guide and the BSP chapter of the Poky Reference Manual. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* BSP Guide: Fixed tag mis-match.Scott Rifenbark2010-11-151-1/+1
| | | | | | | There was a errant tag mis-match where I had used <orderedlist> and ended it with </itemizedlist>. This was preventing the make. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* BSP Guide and BSP Chapter: Sync'ed these two filesScott Rifenbark2010-11-151-124/+134
| | | | | | | | | | | | | | After moving BSP Guide into its own folder for documentation I discovered a consequence of that. There are two separate bsp.xml files now: one in the poky-ref-manual folder and one in the bsp folder. I had done some good cleanup work in the version in the poky-ref-manual folder. This commit reflects a 'meld' operation where I re-sync'ed the bsp.xml file in the bsp-guide folder to be the same (almost) as the one in the poky-ref-manual folder. There is still one slight difference between the two files due to one's context as a stand-alone manual and the other as a section in a larger book. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* BSP Guide: Updated xsltproc command to pass the bsp-guide-customization.xsl ↵Scott Rifenbark2010-11-151-1/+1
| | | | | | | | | | | | | | style sheet. Because I created the file 'bsp-guide-customization.xsl' to try and eliminate odd HTML runtime errors and to allow for customized XSL layer of formatting, it was necessary to update the Makefile to call the new file as the XSL style sheet. The Yocto Project Quickstart uses this technique and has no HTML build problems. HTML build errors seem to be eliminated so far. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* BSP Guide: I created a new figure for the title page.Scott Rifenbark2010-11-151-0/+0
| | | | | | | | Since the BSP Guide is under its own cover I thought it would be good to have its title page not have the Poky Handbook PNG image. I created this BSP image for use with the stand-alone BSP Guide. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* BSP Guide: Created new file for XSL customization expansion.Scott Rifenbark2010-11-151-0/+6
| | | | | | | | | | | I created the file 'bsp-guide-customization.xsl' to try and eliminate odd HTML runtime errors and to allow for customized XSL layer of formatting. The Yocto Project Quickstart uses this technique and has no HTML build problems. HTML build errors seem to be eliminated so far. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* BSP guide: Updated the book id.Scott Rifenbark2010-11-151-1/+1
| | | | | | | I updated the string used for the book id from 'poky-handbook' to 'bsp-guide' Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* BSP Guide Makefile: HTML generation debugging edits.Scott Rifenbark2010-11-151-5/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | I am getting occasional errors while attempting to make the HTML version of this manual. The error is generated from line 367 of the html.xsl style sheet and seems to come from confusion of not finding the css style sheet parameter. Here is the error from the shell window. scottrif@scottrif-desktop:~/poky/documentation/bsp-guide$ make html xsltproc --stringparam html.stylesheet style.css --stringparam chapter.autolabel 1 --stringparam section.autolabel 1 --stringparam section.label.includes.component.label 1 --xinclude -o bsp-guide.html http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl bsp-guide.xml Note: namesp. cut : stripped namespace before processing WARNING: cannot add @xml:base to node set root element. Relative paths may not work. Note: namesp. cut : processing stripped document runtime error: file http://docbook.sourceforge.net/release/xsl/current/xhtml/html.xsl line 367 element choose Variable 'generate.css.header' has not been declared. make: *** [html] Error 10 The odd think is that running "make html" immediately again could cause the make to be entirely successful. So this commit involved moving the XSLTOPTS parameters to the top of the make file and the *_URI parameter declarations to the top as well. This takes them out of the "pdf" area of the make file and they should be more universal. The reason I tried this is because I have no such issues when building the yocto-project-qs HTML file. However, even with these changes the occasional runtime error (shown above) still occurs. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* BSP Developers Guide: Edits to textScott Rifenbark2010-11-151-25/+26
| | | | | | | I made several spelling corrections and rewrote a sentence or two for better structure. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
generated by cgit v1.2.3 (git 2.46.0) at 2024-11-08 23:06:11 +0000