summaryrefslogtreecommitdiffstats
path: root/documentation/bsp-guide
Commit message (Collapse)AuthorAgeFilesLines
* documentation: updated manual historyScott Rifenbark2011-06-131-0/+5
| | | | | | | | | | | I added an entry to represent the Yocto Project 1.0.1 Release into the manual history table for all of the manuals except the Yocto Project Quick Start, which does not have a table. (From yocto-docs rev: d2c570b18854b3f15dfb20436a2212f569e96d5f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: [YOCTO #1025] build system for docsBeth Flanagan2011-06-131-37/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | These changes fix the following issues: 1. Multiple Makefiles. There really is no need for this. 2. Unable to maintain more than one version of the docs on the webserver. This is a quick fix to enable the above. In order to build the documentation, at the top level, issue a: make all DOC=<doc directory name> make all DOC=kernel-manual Also, some changes need to occur on the webserver to fully incorporate these fixes. http://www.yoctoproject.org/documentation/ The docs are now published to: http://www.yoctoproject.org/docs/<Release MM.mm>/<doc name> The main page should be changed to point not only to the current doc release, but also to the prior releases. This will enable us to maintain prior release documentation without stomping over it when we publish new docs. Also, we'll need to repoint the yocto-quick-start link to yocto-project-qs. Or rename documentation/yocto-project-qs/* to support the website naming. (From yocto-docs rev: 2651790d80fd32cd4619eeb5375f6ee28e7e7fda) Signed-off-by: Beth Flanagan <elizabeth.flanagan@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/bsp-guide/bsp.xml: Updated Example Filesystem LayoutScott Rifenbark2011-05-171-0/+20
| | | | | | | | | | | | Added more explanation about the base directory (meta-<bsp_name>) to the Example Filesystem Layout section. These changes were suggested by Tom Zanussi to help users understand better how to add BSP layers to the build system. (From yocto-docs rev: ced445910363b2f10b5b5ca72236f54ae4b7e050) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/bsp-guide/bsp.xml: Updated link to BSP Download siteScott Rifenbark2011-05-171-7/+7
| | | | | | | | | | | | | In the 'BSP Click-Through Licensing Procedure' section there was an old link to the BSP download page on the Yocto Project website. The link was non-functional. I fixed the link so that it points to the Yocto Project BSP Download page. I also re-wrote the paragraph to read better. (From yocto-docs rev: b87714fa54f71aa061126b7f29d80723a90818e8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/bsp-guide/bsp.xml: Updated /binary explanationScott Rifenbark2011-05-171-2/+2
| | | | | | | | | | | | | | In the '1.1.3 Pre-built User Binaries' section it said that the ADT and minimal images were kept in the optional meta-<bsp_name>/binary directory. Jianjun Xu pointed out that in fact it is just the minimal and sato images here. I also confirmed with Tom as well. I re-wrote this sentence to be clearer and more accurate. (From yocto-docs rev: 6757abff52841b5d1e1991ab22314fa7a243a87d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/bsp-guide/bsp.xml: BBFILES statement corrected.Scott Rifenbark2011-05-171-2/+3
| | | | | | | | | | | | In the '1.1.4 Layer Configuration File' section there was a BBFILES statment that used the '\' character to indicate a continuation of the command on the following line. However, the example did not use a new line. I added the hard-return to correct that in the example. (From yocto-docs rev: 185352ae2f5879a8418715053f3791b167bd6d7e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/bsp-guide/bsp.xml: bsp exmaple name fixedScott Rifenbark2011-05-171-1/+1
| | | | | | | | | | Changed the example BSP name 'meta-intel_n450' to 'meta-n450' in the section 'Example Filesystem Layout.' Error found by Jiajun Xu. (From yocto-docs rev: 0dd6f97dcc51cec4bae96ca0430af9300619749f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Removed hardcoded user name from publish optionScott Rifenbark2011-05-101-2/+2
| | | | | | | | | | | I removed the hardcoded name from the publish option. This involved updating the Makefiles. The publish option is still temporary as a more permanent solution is being created. (From yocto-docs rev: 6878b2ccdb98b18c438ca419e1caad0041a2bc00) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* BUGID#_956 - documentation/bsp-guide/Makefile: Updated for publish processScott Rifenbark2011-05-101-4/+6
| | | | | | | | | | | BUGID#_956: I updated the Make file so that it will push the HTML and PDF files automatically to the yocto project site. This takes care of BUGID#_956 for the BSP Guide. (From yocto-docs rev: 684f1836056c977c08a27a0a80d622e360977919) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/bsp-guide/figures/poky-ref-manual.png: Removed figureScott Rifenbark2011-05-101-0/+0
| | | | | | | | | Removed this figure as it is not used in the manual. (From yocto-docs rev: 6fa2c18a7ea647386a113e0e50860d66ecb83e4a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/bsp-guide/Makefile: BUGID#_956 - fixing publish processScott Rifenbark2011-05-091-1/+1
| | | | | | | | | | Added the URL for the manual to the rcp publishing process. This is part of the fix for this bug. (From yocto-docs rev: 4d25c5e1cd6f0b067d0a88fbde1ac6df7066dfa4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Update publishing locationSaul Wold2011-05-091-1/+1
| | | | | | | (From yocto-docs rev: 2f55104fe696f55d1f4ebb7f2cfcb3a2fd89385e) Signed-off-by: Saul Wold <sgw@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Rename poky-image-* -> core-image-* and task-poky-* -> task-core-*Richard Purdie2011-04-211-1/+1
| | | | | | (From yocto-docs rev: 0feb6b8f9621087ba5fd77d3c8f3e23132c97187) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/bsp-guide/Makefile: Updated to include PDF in tarballScott Rifenbark2011-03-311-1/+1
| | | | | | | | | | For some reason the PDF version of this manual was not being included in the tarball created by the Makefile. I fixed this. (From OE-Core rev: f8ec09ab31c04b2ae9570b71174f50c58ad09f00) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/bsp-guide/bsp.xml: Spell checkScott Rifenbark2011-03-181-4/+5
| | | | | | | | | Performed a spell check and caught a couple small things. (From OE-Core rev: 17ae7d1e05df495a5e27168cdcdfbcf96337a3f9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/bsp-guide/style.css: Updated Style SheetScott Rifenbark2011-03-181-9/+15
| | | | | | | | | | | I updated the HTML style sheet to match that of the other online manuals. Section heads are now in Yocto blue and tip box color is inline with Yocto color schemes. (From OE-Core rev: 815b71a6c66e529959a12bd9aa6aabc0afc78bb1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/bsp-guide/bsp-guide.xml: Updated Title PageScott Rifenbark2011-03-181-6/+7
| | | | | | | | | | I updated the revision table for the manuals to have better wording and to go from oldest to newest top down. (From OE-Core rev: 7a4f802bb4d12f863a13fc4ba095a3de149aa6df) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/bsp-guide/figures/bsp-title.png: Updated PNG file for titleScott Rifenbark2011-03-181-0/+0
| | | | | | | | | | I updated the figure for the title so that it uses the same color scheme as the other manuals. (From OE-Core rev: 23c40367c56e838bb9c1ad89cec8ca2e563a40a7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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 (From OE-Core rev: 7f1662ef01b383c9fecb2b30ade50de97f17529a) Signed-off-by: Tom Zanussi <tom.zanussi@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/bsp-guide/bsp-guide.xml: Updated revision history on title page.Scott Rifenbark2011-03-031-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. (From OE-Core rev: 5ba502311221c3a476465d148fcfecf557fbfe79) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/bsp-guide/bsp-guide.xml: Updated RP email addressScott Rifenbark2011-03-031-1/+1
| | | | | | | | | | Changed the email address for Richard Purdie in the author title page to richard.purdie@linuxfoundation.org. (From OE-Core rev: 86e355f489437c4d20a717617d203a8a5aa1371a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* - documentation/bsp-guide/figures/bsp-title.png: Updated title graphicScott Rifenbark2011-03-031-0/+0
| | | | | | | | | | | | | | [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. (From OE-Core rev: f6d9338bf98f2f6791231a5ff74142833ae1363e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* - documentation/bsp-guide/bsp.xml: Re-write of click-throughScott Rifenbark2011-03-031-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). (From OE-Core rev: 4c2dcb376b4be0778cab97138fefdb8a27a0e708) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/bsp-guide/bsp-guide.xml: Updated copyrightScott Rifenbark2011-02-251-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>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-11 14:50:52 +0000