Commit Graph

167 Commits

Author SHA1 Message Date
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