Commit Graph

4282 Commits

Author SHA1 Message Date
Scott Rifenbark b931aaa678 documentation/yocto-project-qs/yocto-project-qs.xml: Added Copyright dates
Added "Copyright 2010-2011 Linux Foundation" under the title.  For
now this will have to do.  Once we get the converted website up I
would like to see all manuals displayed as HTML files within the
context of the site layout.  At that point we can have a copyright
and trademark stuff in a persistent footer.

[BUGID #696]

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-02-25 09:10:28 -08:00
Scott Rifenbark f6fdcb661b documentation/kernel-manual/kernel-manual.xml: Updated copyright date
Changed the copyright date from "2010" to "2010-2011".

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-02-25 09:10:28 -08:00
Scott Rifenbark efab5b131d documentation/bsp-guide/bsp-guide.xml: Updated copyright
Changed copyright date from "2010" to "2010-2011"

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-02-25 09:10:28 -08:00
Scott Rifenbark fa0792896c documentation/poky-ref-manual/poky-ref-manual.xml: updated copyright date
Changed the copyright upper date from 2010 to 2011.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-02-25 09:10:28 -08:00
Scott Rifenbark 0697f34aa2 documentation/poky-ref-manual/faq.xml: [BUGID# 628] - Added new question for Python 2.6 requirement.
As part of the fix for #628 I added a new question to the FAQ for use
of Poky when you do not have Python 2.6.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-02-23 10:55:10 -08:00
Scott Rifenbark 92de0ed852 documentation/yocto-project-qs/yocto-project-qs.xml: [BUGID# 628] - Added note about Python 2.6 bitbake requirement
Part of the fix for Bug 628 is to add a note that bitbake requires
python 2.6.  I added this note before the example bitbake command
that builds an image.  I also added a linked reference to the Poky
Reference Manual and mentioned the FAQ appendix.  There will be more
information about the python requirement in the FAQ.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-02-23 10:55:10 -08:00
Scott Rifenbark 9f0f7c4390 documentation/kernel-manual/kernel-how-to.xml: Changes to section 3.4.4 and new 3.4.5
I made some updates to the 3.4.4 section according to Bruce Ashfield's
feedback.  I also added a new section 3.4.5 (Creating a BSP Based on an
Existing Similar BSP Without a Local Kernel Repository).

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-02-18 20:51:30 -08:00
Scott Rifenbark 07c159fd22 documentation/kernel-manual/kernel-how-to.xml: fix to step 3 and 4 of section 3.4.4
Added text after the sample bbappend file stating that the user needs
to update the KSRC assignment statement and also remove its comment.
Also they have to remove the comment from the SRC_URI line.

Changed the bitbake command in step 4 to use the linux-yocto-stable
file rather than the linux-yocto file.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-02-18 20:51:30 -08:00
Scott Rifenbark 6500cef062 documentation/kernel-manual/kernel-how-to.xml: Fix to step 3 of section 3.4.4
Changed 'linux-yocto_git.bbappend' to 'linux-yocto-stable_git.bbappend'
in step 3 just before the code example.  This makes the code consistent
with the rest of the example supporting the 2.6.34 kernel.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-02-18 20:51:30 -08:00
Scott Rifenbark 7c06c4f545 documentation/kernel-manual/kernel-how-to.xml: Fix to step 1 of section 3.4.4
Step one states that the linux-yocto_git.bbappend file is left.  This
file is associated with distro 2.6.37 kernel and the rest of the
example is associated with the 2.6.34 kernel.  So, I changed the
step to indicate that the directory is left with a linux-yocto-stable_git.bbappend
file.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-02-18 20:51:30 -08:00
Scott Rifenbark 647aaad6fb documentation/kernel-manual/kernel-how-to.xml: More changes to the creating BSP section.
These changes implemented Bruce Ashfield's next round of changes to the
section 4.3.3 example.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-02-14 17:07:36 -06:00
Scott Rifenbark 05ac368888 documentation/kernel-manual/kernel-how-to.xml: Fixed type
In section 4.3.3 step 2 there was a directory 'build/donf/bblayers.conf'.
I fixed the typo to 'build/conf/bblayers.conf'.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-02-14 17:07:35 -06:00
Scott Rifenbark 09e2aac993 documentation/kernel-manual/kernel-how-to.xml: - Condense and merge example changed.
The example used to show how to condense and merge two BSPs into a second
SCM used a non-existant machine (cav_ebt5800-standard).  I replaced this
machine with 'common_pc_64-standard, which is a real machine.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-02-14 17:07:35 -06:00
Scott Rifenbark 2a8c4a32be documentation/kernel-manual/kernel-how-to.xml: [BUGID# 597] Reversing common-pc-standard
[BUGID# 597] - After talking with Bruce Ashfield the kernel documentation
needs to support the 2.6.34 disribution.  So, the 'common-pc-standard'
strings need to be changed back to 'common_pc-standard'.  This fix restores
them.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-02-14 17:07:35 -06:00
Scott Rifenbark f8c5a63a25 documentation/yocto-project-qs/yocto-project-qs.xml: [BUGID# 631] - Added tip for saving disk space during a build.
[BUGID# 631] - I added a tip in the section where we show a sample build.
The tip says that you can add 'INHERIT += "rm_work"' to the local.conf file
to help conserve disk space during a build.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-02-14 17:07:35 -06:00
Scott Rifenbark 721a9340d6 documentation/kernel-manual/kernel-how-to.xml: [BUGID# 597] Fixed common_pc
[BUGID# 597] - Changed the string "common_pc" to "common-pc".

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-02-14 17:07:35 -06:00
Scott Rifenbark ecac1c77c6 documentation/poky-ref-manual/extendpoky.xml: Fixed make problem
Discovered that the manual was not making correctly due to a stray
</literallayout> statement.  I removed this statement and the manual
now builds.

Signed-off-by: Scott Rifenbark <scott@scott-desktop.(none)>
2011-02-01 23:45:13 -08:00
Scott Rifenbark 74c24e08af documentation/yocto-project-qs/yocto-project-qs.xml: Added note to poky-qemu command
Depending on the architecture you are booting and the profile of the
filesystem image QEMU might come up in a new shell, and existing shell,
have a GUI, or be in command-line mode.  I added a note indicating this
behavior.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-01-25 11:58:52 -08:00
Scott Rifenbark 63e6319bd1 documentation/yocto-project-qs/yocto-project-qs.xml: Updated <arch> value for environment setup command
The value for the 64-bit architecture was "x86-64" and not "x86_64".
Changed it to be correct.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-01-25 11:58:51 -08:00
Scott Rifenbark bcce31b495 documentation/yocto-project-qs/yocto-project-qs.xml: Updated list introducing pre-built section
The section that introduces the using a pre-built binary section needed
more items in the list.  I added text for setting up the environment
and for starting QEMU.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-01-25 11:58:50 -08:00
Scott Rifenbark dc124306b5 documentation/yocto-project-qs/yocto-project-qs.xml: Added sub-sections to pre-built image section
The pre-built image section was one long section that naturally
broke into several areas.  I inserted some sub-sections for better
organization.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-01-25 11:58:48 -08:00
Scott Rifenbark d0be418074 documentation/yocto-project-qs/yocto-project-qs.xml: Corrected environment setup command
I added the exact architecture strings for each of the five supported
architectures as part of the /opt/poky/environment-setup.... commands
resulting from installing the toolchain tarballs.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-01-25 11:58:47 -08:00
Scott Rifenbark 9da1e13e73 documentation/yocto-project-qs/figures/using-a-pre-built-image.png: Updated figure
Changed the figure so that "File System" is "Filesystem"

Signed-off-by: Scott Rifenbark <scott@scott-desktop.(none)>
2011-01-20 21:37:01 +00:00
Scott Rifenbark 75ee154c64 documentation/yocto-project-qs/yocto-project-qs.xml: General edits to YP QS.
Revised the manual for better grammar and more technically accurate wordings.
Worked closely with Scott Garman on the revision.

Signed-off-by: Scott Rifenbark <scott@scott-desktop.(none)>
2011-01-20 21:37:01 +00:00
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
Paul Eggleton 321d70e186 documentation/bsp-guide/bsp.xml: fix typo in variable name
FILESEXTRAPATH -> FILESEXTRAPATHS

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2011-01-20 21:37:00 +00:00
Scott Rifenbark 163581fe32 documentation/yocto-project-qs: Updated the Packages section.
Added the packages autoconf and automake to both the Debeian-based
host and the RPM-based host example commands.  During a fresh
development host system test run I found these packages were
necessary to develop Yocto projects using Eclipse IDE.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-01-18 17:54:52 +00:00
Scott Rifenbark bcb5849243 documentation/yocto-project-qs/yocto-project-qs.xml: Corrections to Using Pre-Built Binaries and QEMU section.
Made several small changes:

 - Added a period to three-bullet list for consistency
 - grammar fix to sentence
 - Added clarification for getting stuff from qemu URL
 - Fixed the forms for the image and the file system image

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-01-06 16:21:12 -08:00
Scott Rifenbark bc127e0ec9 documentation/bsp-guide/bsp.xml: Commented out three sections.
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>
2011-01-06 16:21:05 -08: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
Scott Rifenbark a034fad8d0 documentation/bsp-guide/bsp.xml: Spell checked the file.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-21 12:49:46 +00:00
Scott Rifenbark 94f7dd2629 documentation/bsp-guide/bsp.xml: Updated Linux Kernel Configuration section.
Another round of feedback from Tom Z applied.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-21 12:49:46 +00:00
Scott Rifenbark 1d671c41df documentation/bsp-guide/bsp.xml: replaced the append file line in the template
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>
2010-12-21 12:49:45 +00:00
Scott Rifenbark 6224858276 documentation/bsp-guide/bsp.xml: Updated the Linux Kernel Configuration section
These changes are another round of edits from Tom Z.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-21 12:49:45 +00:00
Scott Rifenbark 885dbc7364 documentation/bsp-guide/bsp.xml: Added reference to Kernel documentation.
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>
2010-12-21 12:49:45 +00:00
Scott Rifenbark 3ad6173f78 documentation/bsp-guide/bsp.xml: Updated Linux Kernel Configuration section.
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>
2010-12-21 12:49:45 +00:00
Scott Rifenbark 5b5fe28ee0 documentation/bsp-guide/bsp.xml: Updated Display Support Files section.
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>
2010-12-21 12:49:45 +00:00
Scott Rifenbark 6534947d6b documentation/bsp-guild/bsp.xml: Updated Miscellaneous Recipe Files section
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>
2010-12-21 12:49:45 +00:00
Scott Rifenbark 8505df2614 documentation/bsp-guide/bsp.xml: Updated Layer Configuration File Section
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>
2010-12-21 12:49:45 +00:00
Scott Rifenbark 8e947f92ad documentation/bsp-guide/bsp.xml: Changed numbering scheme.
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>
2010-12-21 12:49:45 +00:00
Scott Rifenbark 27ff33fce5 documentation/bsp-guide/bsp.xml: Commented out three sections.
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>
2010-12-21 12:49:44 +00:00
Scott Rifenbark 7f18ffe313 documentation/bsp-guide/bsp.xml: Updated Linux Kernel Configuration section.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-21 12:49:44 +00:00
Scott Rifenbark 23f5c9482b documentation/bsp-guide/bsp.xml: Added a Display Support Files section.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-21 12:49:44 +00:00
Scott Rifenbark 6eed8ff107 documentation/bsp-guide/bsp.xml: Removed the recipes-bsp/formfactor directory from the common structure.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-21 12:49:44 +00:00
Scott Rifenbark eddd579546 documentation/bsp-guide/bsp.xml: Added a Miscellaneous Recipe Files section
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-21 12:49:44 +00:00
Scott Rifenbark 7527f7597d documentation/bsp-guide/bsp.xml: Updated the Hardware Configuration Options section
I combined the tuning stuff into this section.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-21 12:49:44 +00:00
Scott Rifenbark 1e68ee5b65 documenation/bsp-guide/bsp.xml: Updated the Layer Configuration File section.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-21 12:49:44 +00:00
Scott Rifenbark b3b9476dc5 documentation/bsp-guide/bsp.xml: Updated the Pre-built User Binaries section.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-21 12:49:43 +00:00
Scott Rifenbark e71027eaf2 documentation/bsp-guide/bsp.xml: Added the README section.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-21 12:49:43 +00:00
Scott Rifenbark 0ab1b2c31c documentation/bsp-guide/bsp.xml: Added new "License Files" section.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-21 12:49:43 +00:00
Scott Rifenbark cd9dc32945 documentation/bsp-guide/bsp.xml: Updated the introductary paragraph to the sections.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-21 12:49:43 +00:00
Scott Rifenbark 581bf7fd7f documentation/bsp-work/bsp.xml: Added crownbay BSP example to section 1.1.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-21 12:49:43 +00:00
Scott Rifenbark 6e82f12f79 documentation/bsp-guide/bsp.xml: Updated common form for file structure.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-21 12:49:43 +00:00
Scott Rifenbark 91cf2634c7 documentation/bsp-guide/bsp.xml: Inserted text before the file structure 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>
2010-12-21 12:49:43 +00:00
Scott Rifenbark 49ebf6b85c documentation/bsp-guide/bsp.xml: Created better BSP example base names
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>
2010-12-21 12:49:43 +00:00
Scott Rifenbark e2b180ab54 documentation/bsp-guide/bsp.xml: Added information about /binary
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>
2010-12-21 12:49:43 +00:00
Scott Rifenbark 775b4aea12 documentation/bsp-guide/bsp.xml: Fixed typo
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>
2010-12-21 12:49:43 +00:00
Scott Rifenbark 5405b3de3e documentation/bsp-guide/bsp.xml: Added note qualifying BSP file structure.
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>
2010-12-21 12:49:43 +00:00
Scott Rifenbark 7e4b55b098 documentation/bsp-guide/bsp.xml: Changed meta naming convention
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>
2010-12-21 12:49:42 +00:00
Scott Rifenbark eac0898c4e documentation/yocto-project-qs/yocto-project-qs.xml: Fixed grammar problem
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-12-20 14:43:56 +00:00
Scott Rifenbark ba3b0db61f documentation/kernel-manual/figures/kernel-architecture-overview.png: updated figure
Updated the figure to not use "preempt_rt".  Now uses "preempt-rt".

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-12-20 14:41:44 +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 27c117141f documentation/bsp-guide/bsp.xml: General edits.
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>
2010-12-14 13:43:55 -08:00
Darren Hart e7f5bc2504 bsp-guide: correct BBPATH example
The BBPATH example was missing a : to separate the path elements.

Signed-off-by: Darren Hart <dvhart@linux.intel.com>
2010-12-14 13:43:55 -08:00
Scott Rifenbark ef8e0d6f38 documentation/kernel-manual/kernel-how-to.xml: added newline character
There was a git checkout and git push command that did not have a newline
character between the two line in a literallayout block.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-14 13:43:55 -08:00
Scott Rifenbark 22cd27dac4 documentation/kernel-manual/kernel-how-to.xml: fixed typo bug 588
removed the ";" character that was part of the git log --pretty=oneline
command example.  This fixes bug [BUGID# 588].

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-14 13:43:54 -08: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 be622ae87e documentation/kernel-manual/kernel-concepts.xml: Re-worded a note to state best practices for organizing shared features.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:28 -08:00
Scott Rifenbark 579b5c2947 documentation/kernel-manual: Added Bruce Ashfields review comments.
Comments covered some minor points.  We did remove the "Creating
a Transition Kernel Layer" section however.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:27 -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 11cdfab9cd documentation/yocto-project-qs: Added the gnome-doc-utils package to the Fedora required pacakge list.
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 23dcc1bf97 documentation/kernel-manual: Added an image to the authorgroup so a title would display in the HTML version of the manual.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:21 -08:00
Scott Rifenbark ddbd172dd8 documentation/kernel-manual/kernel-how-to.xml: Completed scrub to the text.
This version represents the completed first draft with all of Bruce Ashfield's comments applied and a good scrubbing of the text.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:20 -08:00
Scott Rifenbark 5bda926c80 documentation/kernel-manual/kerenel-how-to.xml: Edits to clean up text.
Re-writing up to the "Export for External (Upstream) Submission" section.
I am cleaning up the English and style.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:19 -08:00
Scott Rifenbark 1722898e16 documentation/kernel-manual/kernel-manual.xml: Changed the copyright statement to conform to sharing.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:19 -08:00
Scott Rifenbark 14a8edb09c documentation/kernel-manual/kernel-concepts.xml: Updated the text so that the conceptual figure showing the kernel is out.
Feedback indicated by Dave suggested getting rid of this.  So I commented out the text around it and modified the reminder text so it did not reference a figure.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:18 -08:00
Scott Rifenbark 15cf572f3e documentation/kernel-manual: Modified to call new chapter structure.
The make process for the kernel book now includes multiple chapters instead of a single chapter.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:17 -08:00
Scott Rifenbark 2a993a0dac documentation/kernel-manual: Added these files so the book could have chapters.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:17 -08:00
Scott Rifenbark d2e540116f documentation/kernel-manual/yocto-project-kernel-manual.xml: Removed this file so manual could be structured into a book with chapters.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:16 -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 62ef8bdc57 documentation/kernel-manual/Makefile: changed the pdf, tgz, and html output files to be named "kernel-manual"
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:15 -08:00
Scott Rifenbark 05c8e137e4 documentation/kernel-manual/Makefile: changed the name of the PDF output file to "kernel-manual.pdf"
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:14 -08:00
Scott Rifenbark c479301fca documentation/kernel-manual/kernel-manual.xml: added this file so that PDF could be built.
This is inline with how the other docs are built.  kernel-manual.xml
is called by xsltproc from the Makefile.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:14 -08:00
Scott Rifenbark d468cc4e49 documentation/kernel-manual/yocto-project-kernel-manual.xml: removed the code that inserts the image.
I made this file similar to the bsp.xml file so that it would build into
a PDF file.  It was throwing an error because of the imagedata tag
that was up front.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:13 -08:00
Scott Rifenbark 5ed39a3770 documentation/kernel-manual/Makefile: Added code to create a PDF version.
Code now calls a new file called kernel-manual.xml that in turn
includes the yocto-project-kernel-manual.xml file.  This is in line
with how the other docs are built.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:13 -08:00
Scott Rifenbark 5d64bb0193 documentation/kernel-manual/figures/kernel-title.png: Added a PNG file to display in the PDF version on the title page.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:12 -08:00
Scott Rifenbark b89a971761 documentation/kernel-manual/yocto-project-kernel-manual.xml: Added a new section called "BSP: Creating:
this section is based on an email that Bruce Ashfield sent me.  It replaces
what was in there in the form of sub-sections for creating a new BSP,
cloning one and bsp bootstrapping.
2010-12-10 22:01:12 -08:00
Scott Rifenbark 7dbdd91eb9 documentation/kernel-manual/style.css: Changed h2 through h6 styles.
I needed more demarcation for these section titles.  They were not visually
different enough.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:11 -08:00
Scott Rifenbark 5b10a72004 documentation/kernel-manual/yocto-project-kernel-manual.xml: Removed sections not fit for 0.9 release.
These sections were commented out after a review by Bruce Ashfield.  They
need to be revisited as we continue with the 1.0 work.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:10 -08:00
Scott Rifenbark 2982e7c405 documentation/kernel-manual/yocto-project-kernel-manual.xml and yocto-project-kernel-manual-customization.xsl: Renamed files with correct spelling for kernel.
I had to rename these files because I had kernel mis-spelled when I committed
the original manual files.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:09 -08:00
Scott Rifenbark bad46abb89 documentation/kernel-manual/yocto-project-kernal-manual.xml: and yocto-project-kernal-manual-customization.xsl removed from tree.
I noticed I had mis-spelled kernel for these files names after committing
the new kernel manual.  I renamed the files and had to remove these two.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:09 -08:00
Scott Rifenbark 3e7a8a64af documentation/kernel-manual/Makefile: fixed mis-spelling of kernel for files
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:08 -08:00
Scott Rifenbark 000f052765 documentation/kerenl-manual: New directory and files for kernel manual.
This is the first draft of the Yocto Project Kernel manual.  The
manual consists of two sections: concepts and a practical section that
has examples.  It is based of Bruce Ashfield's kernel theory paper.
This first draft has been re-written and organized through the
concepts section.  The remainder was just placed in as-is due to
time constraints for getting some kernel documentation up on the website.
The manual still needs scrubbing and organization in the latter half.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:07 -08:00
Scott Rifenbark aa58345393 documentation/yocto-project-qs/yocto-project-qs.xml: Corrected poky-qemu command example in the 'Using Pre-Build Binaries and QEMU' section.
Added fstype to the command form and also inserted an example use.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:07 -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 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
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 4ededb2549 Corrected the package command for Debian-based hosts.
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>
2010-10-27 07:51:03 +01:00
Scott Rifenbark fd832c02eb Added package installation requirements.
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>
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
Scott Rifenbark 2ccf2b358d Re-installed the Poky Handbook image at the top of the manual
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>
2010-10-27 07:51:02 +01:00
Scott Rifenbark 27e2d19e6d Updated the yocto-environment picture and added example command edits.
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>
2010-10-27 07:51:02 +01:00
Richard Purdie aea5da08ff docmentation/yocto-project-qs: Fix Yocto Environment graphic
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-10-27 07:51:02 +01:00
Scott Rifenbark e4d0ba820e Removed first link to openembedded and replaced with more general text.
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>
2010-10-27 07:51:02 +01:00
Scott Rifenbark ca822c5396 Updated the first figure in the quick start.
This conceptual figure has been replaced by a more detailed work
flow representing YP.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-10-27 07:51:01 +01:00
Scott Rifenbark 03c72a9e4a Corrected link to the yocto website.
This link was incorrect and has been changed to yoctoproject.com.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-10-27 07:51:01 +01:00
Scott Rifenbark 7fba85a6aa Updated supporting text to reflect new poky-4.0-build directory in example
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>
2010-10-27 07:51:01 +01:00
Richard Purdie 5bebcef517 documentation-project-qs: Remove stray ]
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-10-27 07:51:01 +01:00
Richard Purdie 962e548d1c documentation/qs-guide: Fix urls for release
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-10-27 07:51:01 +01:00
Scott Rifenbark 7af5e26383 Edits as described below:
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>
2010-10-27 07:50:34 +01:00
Scott Rifenbark 5434a49f3d Review changes applied.
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>
2010-10-27 07:50:34 +01:00
Scott Rifenbark 11686d07a2 Updated figure.
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>
2010-10-27 07:50:34 +01:00
Scott Rifenbark 9692685753 Updated this figure to correctly capaitalize opkg, zyper, and app-get
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>
2010-10-27 07:50:33 +01:00
Scott Rifenbark cb9376f79a Removed reference to pre-build in section 5.3.2, "Using OprofileUI".
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>
2010-10-27 07:50:33 +01:00
Scott Rifenbark 95a85f5688 Added the Anjuta Plug-in information
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>
2010-10-27 07:50:33 +01:00
Richard Purdie 4999f78874 documentation/pokt-ref-manual: Update with Yocto branding
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-10-27 07:50:33 +01:00
Richard Purdie 00e061b564 documentation: Add Yocto quickstart guide
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-10-27 07:50:33 +01:00
Joshua Lock eef1d813b7 documentation/bsp: update to reference FILESEXTRAPATHS
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>
2010-10-22 13:56:31 +01:00
Richard Purdie 6562e7cdd0 documentation/poky-ref-manual: Update packages references to recipes and make sure bbappend files are included in example BBFILES lines
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-10-19 20:18:32 +01:00
Richard Purdie 80eba26fb1 documentation/poky-ref-manual: Various tweaks to the text
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-10-15 15:07:06 +01:00
Richard Purdie 0be66f0e88 documentation/tools: Add comments to script
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-10-15 15:07:05 +01:00
Richard Purdie 95cf36fbd1 documentation: Complete poky-handbook -> poky-ref-manual rename
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-10-15 12:45:09 +01:00
Richard Purdie 37eb4e2b93 documentation/handbook: Tweak Makefiles and paths after path changes
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-10-15 12:14:28 +01:00
Richard Purdie 94c2a3c0ab handbook/poky-ref-manual: Makefile tweaks
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-10-15 11:57:01 +01:00
Richard Purdie 2208328791 handbook: Move into documentation directory
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-10-15 11:55:59 +01:00