Commit Graph

81 Commits

Author SHA1 Message Date
Scott Rifenbark eccaafa620 documentation/poky-ref-manual/development.xml: Fixed orderedlist and itemizedlist spacing.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:06 -08:00
Scott Rifenbark a20a167cf7 Poky Reference Manual: General edits to the developing chapter.
Completed the second half edits to this chapter.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:06 -08:00
Scott Rifenbark 8feae13423 Poky Reference Manual: Added INC_PR documentation.
Added an entry in the glossary for INC_PR.  Also updated section
"Package Revision Incrementing" to mention the use of INC_PR in conjuntion
with the PR and PV variables.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:05 -08:00
Scott Rifenbark e7e12483e4 BSP Guide and BSP Chapter: Sync'ed these two files
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>
2010-12-10 22:01:05 -08:00
Scott Rifenbark 12d1378990 BSP Developers Guide: Edits to text
I made several spelling corrections and rewrote a sentence or two for
better structure.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:04 -08:00
Scott Rifenbark 62f93ac42d Poky Reference Manual: General edits up to the "Debugging with GDB Remotely" section.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:26 +00:00
Scott Rifenbark 175be120f3 Poky Reference Manual: Added a glossary definition for BBPATH.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:26 +00:00
Scott Rifenbark 444597f44e Poky Reference Manual: Task wording made consistent
I am using "xxxxxx" task as the way to call out a specific task in the
text.  Previously a mix of <function>xxxxxx</function> and the "xxxxxx"
methods were being used.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:26 +00:00
Scott Rifenbark 8914519565 Poky Reference Manual: General edits for English.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:25 +00:00
Scott Rifenbark c2f7ed472c Poky Reference Manual: Removed the bsp.xml file.
Because I am single-sourcing the bsp.xml file that is used both as
chapter 4 in the Poky Reference Manual and as the singe file in the BSP
Guide I removed the bsp.xml file that was local to the poky-ref-manual
folder.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:25 +00:00
Scott Rifenbark b1f69283b3 BSP Guide and BSP Chapter in Poky Reference Manual: Changed wording
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>
2010-11-15 22:25:25 +00:00
Scott Rifenbark 2cf5aafc28 Poky Reference Manual: Changed source location of the bsp.xml file
Because BSP chapter (bsp.xml) is identical to the single file used
in the BSP Guide (also bsp.xml but in the bsp-guide folder) I have decided
to change where the Poky Reference Manual get the bsp.xml file.  This commit
causes it to get the file from the bsp-guide folder instead of an identical
but separate bsp.xml file local to the poky-ref-manual folder.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:25 +00:00
Scott Rifenbark 4e6a8212c0 Poky Reference Manual: Fixed list tag.
There was a mis-matched list element in an ordered list near the end
of the chapter.  I had an <orderedlist> tag matched with an </itemizedlist>
tag preventing the make.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:25 +00:00
Scott Rifenbark f30a2a7e4d BSP Guide: Fixed tag mis-match.
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>
2010-11-15 22:25:25 +00:00
Scott Rifenbark 2d6441d17e BSP Guide and BSP Chapter: Sync'ed these two files
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>
2010-11-15 22:25:25 +00:00
Scott Rifenbark 89e64dbe9e Poky Reference Manual: Added XSL Customization layer file
The xsltproc command in the Makefile now uses the XSL Customization
layer style sheet poky-ref-manual-customization.xsl for the style
sheet parameter.  This method will allow for customization of the
HTML version formatting that might be unique for the manual. I have
added the new file to the file structure.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:25 +00:00
Scott Rifenbark c08140c0c8 Poky Reference Manual: Added XSL Customization layer use
The xsltproc command now uses the XSL Customization layer style sheet
poky-ref-manual-customization.xsl for the style sheet parameter.  This
method will allow for customization of the HTML version formatting that
might be unique for the manual.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:25 +00:00
Scott Rifenbark 0a23df95f7 Poky Reference Manual: Clean up Makefile
I moved the XSLTOPTS variables to the top of the file so they will
be defined first.  This is an attempt to fix the seemingly random
HTML runtime errors I am getting during the 'make html' command.
It seems to be consistently working now.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:25 +00:00
Scott Rifenbark 5dc7082f8f Poky Reference Manual: Fixed broken link in Ref Images appendix.
In the Ref Images appendix there was a link to the section
"External Development Using the Poky SDK" section that did not work
due to the section id string changing.  I fixed the link.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:25 +00:00
Scott Rifenbark b978c8e251 Poky Reference Manual: Added BBFILE_PRIORITY glossary term.
The Extending Poky chapter referenced this non-existent term.  I
added it.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:25 +00:00
Scott Rifenbark ab92ec1a87 Poky Reference Manual: Added BBFILE_COLLECTIONS glossary term.
The Extending Poky chapter was referencing a non-existent BBFILE_COLLECTIONS
glossary term.  I added the term.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:25 +00:00
Scott Rifenbark 4a671e54cc Poky Reference Manual: Added BBLAYERS to glossary.
Added an entry for BBLAYERS in the ref-variables (glossary) appendix.
The Extending Poky chapter was referencing this variable and it did not
exist.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:25 +00:00
Scott Rifenbark 731cedfb35 Poky Reference Manual: Spell check performed.
Found and corrected about 6 or 7 mis-spelled words.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:24 +00:00
Scott Rifenbark 3f9700a286 Poky Reference Manual: Added consistency to literallayout text.
I added some indentation for better presentation of the literal text.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:24 +00:00
Scott Rifenbark a915d0105d Poky Reference Manual: Cleaned up and checked all XML tags.
Just a few minor changes like creating consistent indentation.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:24 +00:00
Scott Rifenbark 00b5b4dff7 Poky Reference Manual: XML tag clean up and command example text indentation.
Removed a couple of redundant </ulink> tags.
Also indented the literallayout text by five spaces for formatting.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:24 +00:00
Scott Rifenbark d16bbc076a Poky Reference Manual: A couple more minor fixes.
I found another redundant </ulink> tag.
I removed the word sections from within a section link in a couple of places.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:24 +00:00
Scott Rifenbark bf3ae7f66a Poky Reference Manual: Clean up of the XML tags
Added a section id to the 'welcom to poky' section that was missing.
Removed a redundant </ulink> tag that was not needed.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:24 +00:00
Scott Rifenbark 63596cbfb1 BSP Guide: Updated xsltproc command to pass the bsp-guide-customization.xsl 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>
2010-11-15 22:25:24 +00:00
Scott Rifenbark 6e3576c0aa BSP Guide: I created a new figure for the title page.
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>
2010-11-15 22:25:24 +00:00
Scott Rifenbark d68613e05d BSP Guide: Created new file for XSL customization expansion.
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>
2010-11-15 22:25:24 +00:00
Scott Rifenbark 5ca54c6269 BSP guide: Updated the book id.
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>
2010-11-15 22:25:24 +00:00
Scott Rifenbark 440894bb6f BSP Guide Makefile: HTML generation debugging edits.
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>
2010-11-15 22:25:24 +00:00
Scott Rifenbark 7066eff0bd BSP Developers Guide: Edits to text
I made several spelling corrections and rewrote a sentence or two for
better structure.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:24 +00:00
Scott Rifenbark d7f70e0c20 Added a new PNG file into the tar command.
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>
2010-11-15 22:25:24 +00:00
Scott Rifenbark 00c23106d4 Added a new PNG file (bsp-title.png) as the imagedata tag.
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>
2010-11-15 22:25:24 +00:00
Scott Rifenbark 7c2735f509 Added a new PNG file into the tar command.
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>
2010-11-15 22:25:24 +00:00
Richard Purdie e445fcf5dd poky-ref-manual: Drop non-commercial clause
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-11-13 22:13:00 +08:00
Richard Purdie be132ca72a docmentation/poky-ref-manual: Remove unused Indexes title
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-11-04 21:17:29 +00:00
Scott Rifenbark 4243a61e98 Performed general edits to this chapter.
many english corrections performed.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-04 21:14:08 +00:00
Scott Rifenbark 09ef6a4e13 Poky Reference Manual: Completed editing pass of Chapter 3.
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>
2010-11-04 21:12:46 +00:00
Scott Rifenbark 890a794e38 Created a new folder to hold the BSP Guide
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>
2010-11-04 20:54:30 +00:00
Scott Rifenbark 4b7f1eee28 General edits to the using poky and Extending Poky chapters.
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>
2010-11-04 20:20:06 +00:00
Scott Rifenbark 30e92723e1 General text edits through section 2.4.4 "General Bitbak Problems"
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>
2010-11-04 20:20:06 +00:00
Scott Rifenbark ceef5c20cf Changed a source command to have the correct source.
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>
2010-11-04 20:20:06 +00:00
Scott Rifenbark f7a3a5fe85 Changed the title and wording of the section about pre-built binaries.
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>
2010-11-04 20:20:06 +00:00
Scott Rifenbark e53470656e Editing pass through the Introduction chapter.
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>
2010-11-04 20:20:06 +00:00
Scott Rifenbark 81d3811b2f Figure changed for building an image and yoctolinux removed
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>
2010-11-04 20:20:06 +00:00
Richard Purdie 5dfe9b7d4d documentation: Update copyright to the Linux Foundation
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-10-27 07:51:04 +01:00
Richard Purdie 9fbef508c1 documentation/yocto-qs: Fix references to a poky-qemu package and replace with the yocto toolchain tarball
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-10-27 07:51:03 +01:00