summaryrefslogtreecommitdiff
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* 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>
* Added a new PNG file into the tar command.Scott Rifenbark2010-11-151-3/+3
| | | | | | | | | | Since this manual is about BSP and not Poky as is the Poky Reference Manual I updated the title page to include the title combined with the Yocto Project logo. So for the background-image url in the .authorgroup style I replaced the poky-ref-manual.png file with bsp-title.png. Updates affect both the PDF and HTLM versions of the BSP Guide. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Added a new PNG file (bsp-title.png) as the imagedata tag.Scott Rifenbark2010-11-151-2/+2
| | | | | | | | | Since this manual is about BSP and not Poky as is the Poky Reference Manual I updated the title page to include the title combined with the Yocto Project logo. Updates affect both the PDF and HTLM versions of the BSP Guide. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Added a new PNG file into the tar command.Scott Rifenbark2010-11-151-1/+1
| | | | | | | | | Since this manual is about BSP and not Poky as is the Poky Reference Manual I updated the title page to include the title combined with the Yocto Project logo. Updates affect both the PDF and HTLM versions of the BSP Guide. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* poky-ref-manual: Drop non-commercial clauseRichard Purdie2010-11-131-1/+1
| | | | Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
* docmentation/poky-ref-manual: Remove unused Indexes titleRichard Purdie2010-11-041-2/+3
| | | | Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
* Performed general edits to this chapter.Scott Rifenbark2010-11-041-119/+127
| | | | | | many english corrections performed. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Poky Reference Manual: Completed editing pass of Chapter 3.Scott Rifenbark2010-11-041-384/+389
| | | | | | I completed the editing pass of this chapter by doing sections 3.3.3 on. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Created a new folder to hold the BSP GuideScott Rifenbark2010-11-046-8/+1453
| | | | | | | | | | | I created a new sub folder to hold the BSP Guide by itself so there are three folders now for each of the Yocto manuals: BSP Guide, quick start and poky ref manual. The new folder for the BSP guide is 'bsp-guide'. It contains the bsp.xml file, its own Makefile, a bsp-guide.xml file, and its own 'Figures' directory. The 'bsp-guide.xml' file that was in the poky reference folder was deleted. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* General edits to the using poky and Extending Poky chapters.Scott Rifenbark2010-11-042-265/+221
| | | | | | | | | | | | I completed general edits to the second chapter of the poky reference manual. These edits went from section 2.4.5 through the end of the chapter. They consist of text rewrites for more active voice and follow general technical writing principles. I completed the same types of edits in the third chapter of the manual from the beginning through section 3.3.2. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* General text edits through section 2.4.4 "General Bitbak Problems"Scott Rifenbark2010-11-041-115/+140
| | | | | | | | Extensive language and consistency edits being applied to the manual. During the 0.9 push I did not have time to make a pass through the document. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Changed a source command to have the correct source.Scott Rifenbark2010-11-041-1/+1
| | | | | | | Changed "source poky-4.0/poky-init-build-env poky-4.0-build" to be "source poky-laverne-4.0/poky-init-build-env poky-4.0-build" Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Changed the title and wording of the section about pre-built binaries.Scott Rifenbark2010-11-041-2/+2
| | | | | | | There was a grammatical error in the title and redundancy in the first sentence of this section. Cleaned up the title and wording. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Editing pass through the Introduction chapter.Scott Rifenbark2010-11-041-49/+63
| | | | | | | | | I did a complete edit pass through this chapter. The manual has not been fully edited from its original state. One critical technical correction was corrected where the green-3.3 release was referenced. I changed this to laverne 4.0. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Figure changed for building an image and yoctolinux removedScott Rifenbark2010-11-042-4/+4
| | | | | | | | | I changed the figure that goes along with building an image based on Kevin's input. Also, removed several URLs that had 'yoctolinux' in them along with a 'tar' command example with the same string. LF does not want these in there. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation: Update copyright to the Linux FoundationRichard Purdie2010-10-272-2/+2
| | | | Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
* documentation/yocto-qs: Fix references to a poky-qemu package and replace ↵Richard Purdie2010-10-271-6/+9
| | | | | | with the yocto toolchain tarball Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
* Removed text from section 5.1.2.1.1.Scott Rifenbark2010-10-271-30/+0
| | | | | | Removed several blocks of text from section 5.1.2.1.1 "Installing and Setting up the Eclipse IDE". This text according to Jessica was no longer needed.
* Corrected the package command for Debian-based hosts.Scott Rifenbark2010-10-271-2/+2
| | | | | | | Corrected a typo listing the package libsdl1.2-dev as libsdll.2-dev. Also added the package mercurial. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Added package installation requirements.Scott Rifenbark2010-10-271-3/+22
| | | | | | | Added commands to support package installation of RPM-based host systems to the example. Input based on feedback from Dirk. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Re-inserted Poky Image as part of the front matter.Scott Rifenbark2010-10-271-3/+3
| | | | | | | I have inserted the Poky image in the front matter again because the book is a Poky Guide. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/poky-ref-manual: Fix image makefile to reference the imageRichard Purdie2010-10-271-1/+1
| | | | Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
* Moved the Poky image file to the "Figures" folder.Scott Rifenbark2010-10-271-0/+0
| | | | | | | | The image file was in the same directory as the main reference manual files. So I moved the file into subdirectory "Figures" with other figures. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Re-installed the Poky Handbook image at the top of the manualScott Rifenbark2010-10-271-6/+12
| | | | | | | | | I could not get the Yocto Project logo to appear correctly in the book after the title. I also decided that since Poky is by no means going away that this book should have that image associated with it as it is the Poky Reference Manual. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Updated the yocto-environment picture and added example command edits.Scott Rifenbark2010-10-272-37/+45
| | | | | | | | | | | | When scaled to fit the page the picture had a black vertical line artifact to the right. I snipped out the image a little tigher to eliminate this line. I also incorporated Dirk's comments tightening up the sequence of example commands to do the build. I incorporated Fedora 14 note and addition of the BB_NUMBER_THREADS and PARALLEL_MAKE variables. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* docmentation/yocto-project-qs: Fix Yocto Environment graphicRichard Purdie2010-10-271-0/+0
| | | | Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
* Removed first link to openembedded and replaced with more general text.Scott Rifenbark2010-10-271-2/+2
| | | | | | | | | | The link to openembedded was used to reference Linux distributions supporting Yocto Project. The link has been removed and replaced with more generic text so as to not have to link to openembedded. Text used is "A Host system running a supported Linux distribution (i.e. recent releases of Fedora, OpenSUSE, Debian, and Ubuntu)." Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Updated the first figure in the quick start.Scott Rifenbark2010-10-271-0/+0
| | | | | | | This conceptual figure has been replaced by a more detailed work flow representing YP. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Corrected link to the yocto website.Scott Rifenbark2010-10-271-1/+1
| | | | | | This link was incorrect and has been changed to yoctoproject.com. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Updated supporting text to reflect new poky-4.0-build directory in exampleScott Rifenbark2010-10-271-1/+1
| | | | | | | | The example commands that build an image were updated to reflect the real 4.0 release. I updated the paragraph after the example commands to refer to the new release used in the command examples. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation-project-qs: Remove stray ]Richard Purdie2010-10-271-1/+1
| | | | Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
* documentation/qs-guide: Fix urls for releaseRichard Purdie2010-10-271-7/+7
| | | | Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
* Edits as described below:Scott Rifenbark2010-10-271-10/+10
| | | | | | | | 1) Wording change based on Darren's input of making Linux kernel sound like the only open source part of YL 2) Removal of the "v" option for the tar command example. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Review changes applied.Scott Rifenbark2010-10-271-26/+54
| | | | | | | | | | | | 1. Added Richard Purdie's general editing feedback to the "Welcome" and "Introducing the Yocto Project Development Environment" sections. 2. Added Kevin Tian's feedback: 1) changed "Sudo" to "sudo", 2) reversed the order of the sample "cd" and "source" commands since the "source" command builds the directory structure first so changing to the directory before running "source" made no sense, 3) removed the "bitbake qemu-native" command. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Updated figure.Scott Rifenbark2010-10-271-0/+0
| | | | | | | | | Feedback from Kevin Tian suggested that the outer box be labeled "QEMU" rather than "Target." Also that the two inner boxes be "Set of Emulated Devices" and "Target CPU." Final change was the use of "Yocto Project Scripts" rather than "Yocto Linux Scripts." Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Updated this figure to correctly capaitalize opkg, zyper, and app-getScott Rifenbark2010-10-271-0/+0
| | | | | | | | Feedback from Kevin Tian suggested "OPKG" should be lower-case. Also, use of "zypper" instead of "YUM." I also lower-cased "apt-get." Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Removed reference to pre-build in section 5.3.2, "Using OprofileUI".Scott Rifenbark2010-10-271-4/+3
| | | | | | | | | | The "Using OprofileUI" section had a description of how to use a pre-built UI and how to download and build one. Feedback from Jessica Zhang suggested removing the instruction for using a pre-built UI. All that remains in the first paragraph now is instruction on how to download and build the UI. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Added the Anjuta Plug-in informationScott Rifenbark2010-10-271-33/+171
| | | | | | | | | | | | | | Added section 5.1.2.2 "The Anjuta Plug-in" into the Poky Reference Manual. This section consists of sub-sections 5.1.2.2.1 "Setting Up the Anjuta Plug-in", 5.1.2.2.2 "Configuring the Anjuta Plug-in", and 5.1.2.2.3 "Using the Anjuta Plug-in". This information was in the original Poky Handbook but had been removed by me since I thought it was not going to be supported for the 0.9 Yocto Release. It has now been restored with a note indicating that Anjuta will not be supported post 0.9 release. I did some general text editing in each section for readability. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/pokt-ref-manual: Update with Yocto brandingRichard Purdie2010-10-279-411/+281
| | | | Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
* documentation: Add Yocto quickstart guideRichard Purdie2010-10-2710-0/+1310
| | | | Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
* documentation/bsp: update to reference FILESEXTRAPATHSJoshua Lock2010-10-221-4/+4
| | | | | | | It's no longer neccesarry to define THISDIR and FILESPATH in each bbappend recipe. Should you need to reference extra files you should use FILESEXTRAPATHS Signed-off-by: Joshua Lock <josh@linux.intel.com>
* documentation/poky-ref-manual: Update packages references to recipes and ↵Richard Purdie2010-10-192-7/+7
| | | | | | make sure bbappend files are included in example BBFILES lines Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
* documentation/poky-ref-manual: Various tweaks to the textRichard Purdie2010-10-159-55/+39
| | | | Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
* documentation/tools: Add comments to scriptRichard Purdie2010-10-151-1/+3
| | | | Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
* documentation: Complete poky-handbook -> poky-ref-manual renameRichard Purdie2010-10-156-9/+9
| | | | Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>