Commit Graph

61 Commits

Author SHA1 Message Date
Paul Eggleton 6d5adf1048 documentation/poky-ref-manual: expand discussion of PR and INC_PR
Expands a little on PR and INC_PR.

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2011-01-20 21:37:00 +00:00
Richard Purdie 81e29fbfac poky-ref-manual: Fix my email address
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-01-06 15:43:25 +00:00
Saul Wold 2c37d41ab1 Add glossary for PACKAGE_DESCRIPTION and PACKAGE_SUMMARY for binary packaging
Signed-off-by: Saul Wold <Saul.Wold@intel.com>
2010-12-16 15:52:50 +00:00
Scott Rifenbark 732a117c77 documentation/poky-ref-manual/ref-bitbake.xml: Completed general edits.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:29 -08:00
Scott Rifenbark 9f4c630dbd documentation/poky-ref-manual: changes applied from a patch submitted by Cyril Humbert.
Cyril submitted a patch via email form for several spelling corrections.  The master docs, however, are not up-to-date with what I have on my contrib area.  Many of Cyril's corrections were already addressed.  A few were not and I have updated them here with this commit.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:27 -08:00
Scott Rifenbark 111f0678ee documentation/poky-ref-manual: General edits up the Parsing section.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:26 -08:00
Scott Rifenbark fcbacff683 documentation/poky-ref-manual: Changed spelling of bitbake to "BitBake" when used in text.
There is inconsistent use of how BitBake is spelled.  Sometimes it uses no capitalization, just a leading "B", or "BitBake".  I looked at the BitBake manual and it seems that "BitBake" is the correct way to refer to it.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:25 -08:00
Scott Rifenbark 252cecf379 documentation/poky-ref-manual: English scrub performed for consistency.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:25 -08:00
Scott Rifenbark 57d38a7e7a documentation/poky-ref-manual: Updated Mailing Lists and IRC sections in Appendix I
I pulled the openembedded mailing list information and provided information for yocto@yoctoproject.org, yocto-announce@yoctoproject.org, and poky@yoctoproject.org.  I also updated the IRC section to include both #poky and #yocto channels.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:24 -08:00
Scott Rifenbark 4fe7cb5b21 documentation/poky-ref-manual: Fixed two typo's
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:23 -08:00
Scott Rifenbark 2f4db319b0 documentation/poky-ref-manual: Fixed to mis-spellings
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:22 -08:00
Scott Rifenbark 6d46bc3fcf documentation/poky-ref-manual: Updated the list of links to include a link to the Yocto Project site.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:22 -08:00
Scott Rifenbark c272830d8c documentation/poky-ref-manual/poky-ref-manual.xml: Changed the revision date to 24 November 2010
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:16 -08:00
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 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 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 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
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 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
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
Scott Rifenbark d9fea40f9f Removed text from section 5.1.2.1.1.
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.
2010-10-27 07:51:03 +01:00
Scott Rifenbark 86384c1623 Re-inserted Poky Image as part of the front matter.
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>
2010-10-27 07:51:03 +01:00
Richard Purdie b7ae212e28 documentation/poky-ref-manual: Fix image makefile to reference the image
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-10-27 07:51:03 +01:00
Scott Rifenbark bf77ed9545 Moved the Poky image file to the "Figures" folder.
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>
2010-10-27 07:51:02 +01:00