Commit Graph

152 Commits

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