Commit Graph

147 Commits

Author SHA1 Message Date
Scott Rifenbark 8f67927df6 documentation/bsp-guide/bsp.xml: Added note to BSP recommendations
Inserted a note warning the developer that it is their responsibility
to understand and meet all licensing requirements if they are going
to be including images as part of a BSP.

(From yocto-docs rev: b8154904be02a4185bf417f193eb125b8470bc8d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-06-15 17:18:25 +01:00
Scott Rifenbark 0be49103fd documentation/bsp-guide/bsp.xml: Updates to requirements section
Implemented review feedback from Dave Stewart and Tom Zanussi.

(From yocto-docs rev: 5ed73c29b6a46737a009a38b294bdd61e4c63d85)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-06-15 17:18:25 +01:00
Scott Rifenbark 4969df1279 documentation/bsp-guide/bsp.xml: BSP recommendations section added
Added the "Requirements and Recommendations for Released BSPs"
section.  This section was requested by Dave Stewart based on
community input for direction on how to create a BSP that was
compliant with the Yocto Project.  The input for the section came
from Tom Zanussi.

A spell-check was performed also prior to this commit that addressed
a few spelling issues across the file.

(From yocto-docs rev: 7ed0dd1093b33491231dec06f7b5f8e76004130d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-06-15 17:18:25 +01:00
Scott Rifenbark 1a03b7dfba documentation/bsp-guide/bsp.xml: spelling corrected.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: c0ee8ce391114f7a5b4f1c59fdf997ba4f3bcf75)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-18 16:41:15 +01:00
Scott Rifenbark c0a812c222 documentation/bsp-guide/bsp.xml: Added a info about meta-intel layer
I put a bit of explanation in the "BSP Layers" section about
meta-intel being a layer that in fact contains other BSP layers.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: c57ba6050d7923018709221f7058443293ea6838)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-10 13:32:45 +01:00
Scott Rifenbark ec33e21004 documentation/bsp-guide/bsp.xml: Edits to intro sections
Adding the new section "Customizing a Recipe for a BSP" has added
enough sections to this book such that the introductory area needed
some attention.  I pared down the intro text to basically just
cover the manual's organization and a bit about BSPs.  I moved
all the introductory common form stuff into the section that
just addresses the BSP form.  This is better organization for the
manual as it is evolving.

(From yocto-docs rev: 9aec4ce47fb090ae2f6c5bed93da03e77ae49a4c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-10 13:32:45 +01:00
Scott Rifenbark 273e05bb0d documentation/bsp-guide/bsp.xml: Added new section
Fixes [YOCTO #1962]

Added a new section called "Customizing a Recipe for a BSP".
The text was rooted in Darren Hart's comments.  I implemented
them and then we iterated a bit on it.

Reported-by: Joshua Lock <joshua.lock@intel.com>
(From yocto-docs rev: f5e51d60312d9335a790023f193cae1ba76277ae)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-10 13:32:44 +01:00
Robert P. J. Day 4c35d05623 documentation/bsp-guide/bsp.xml: Patch to fix small issues
Applied a patch from Robert P. J. Day to fix some small issues
in the BSP manual.

(From yocto-docs rev: 7744d5101fd2b5a46a53707976b8899eb03f1c08)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-04 00:34:03 +01:00
Scott Rifenbark 12e5386477 documentation/bsp-guide/bsp.xml: Added some front-matter
Due to the addition of the BSP Tools section, I needed to add a bit
of front-matter to the start of the chapter indicating that we provide
information on how to create and manage a BSP Layer.

(From yocto-docs rev: 7ae34fa58aba6b17866a5379bdcdffd83491ff20)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-03 14:04:58 +01:00
Tom Zanussi 3c566581bd documentation/bsp-guide/bsp.xml: Removed Note
Remove the 'note' that says that the BSP Guide doesn't show how to
create a new BSP.  With the addition of the Yocto BSP Tools section,
that's no longer true.

Also, the wiki page mentioned is out-of-date and probably shouldn't be
pointed to any longer for that reason.

(From yocto-docs rev: 972c2d2bc9f50f5f65b296b7396dc640710ad5b2)

Signed-off-by: Tom Zanussi <tom.zanussi@intel.com>
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-03 14:04:58 +01:00
Scott Rifenbark 23e85906e0 documentation/bsp-guide/bsp.xml: Edits to the BSP Tools section
I have scrubbed the new section for the BSP Tools.  Changes reflect
re-wordings, formatting, etc.

(From yocto-docs rev: c13d5a42665d256c6da6d663611291eef9617f1f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-03 14:04:58 +01:00
Tom Zanussi 0be0e3b350 documentation/bsp-guide/bsp.xml: New section on using BSP tools.
Some documentation introducing and helping get people started with the
Yocto BSP Tools (yocto-bsp and yocto-kernel).

(From yocto-docs rev: 56a6db181f5cdf3c23daa021fe1e9ecb15843678)

Signed-off-by: Tom Zanussi <tom.zanussi@intel.com>
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-03 14:04:57 +01:00
Tom Zanussi 738a9f6ff9 documentation/bsp-guide/bsp.xml: README file not optional
Any shipped BSP needs this file for legal reasons, thus it's
non-optional.

(From yocto-docs rev: 4840f9a9d6b62f61378941c9a8712eb36720efd8)

Signed-off-by: Tom Zanussi <tom.zanussi@intel.com>
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-26 23:30:29 +01:00
Tom Zanussi 5c0b28185e documentation/bsp-guide/bsp.xml: Readme description edits
The README section should not be optional, since at minumum it needs
to contain layer dependencies and maintainer info.

(From yocto-docs rev: 0bb2e8baf9ca7b4f1b8d8c08b4901d1f4312b270)

Signed-off-by: Tom Zanussi <tom.zanussi@intel.com>
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-26 23:30:29 +01:00
Tom Zanussi e7cc307097 documentation/bsp-guide/bsp.xml: Removal of certain layers
Wording changed to remove example BSP layers that really weren't
layers (e.g. meta-intel).  One of three patches from Tom.

Reported-by Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 84677e0ef26f48af9b45585224d6c4dee0406f5e)

Signed-off-by: Tom Zanussi <tom.zanussi>
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-26 23:30:29 +01:00
Scott Rifenbark 40a45af01f documentation/bsp-guide/bsp.xml: Edits to BSP Licensing section
Grammar, style, and formatting edits applied to the "BSP
Licensing Considerations" section.

(From yocto-docs rev: 9809e0b5081bdc4f27d7d949930c409575a9a083)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-23 14:24:50 +00:00
Tom Zanussi 9d2974a31b documentation/bsp-guide/bsp.xml: Patch applied for Licensing
"The LICENSE_FLAGS mechanism can now be used to meet the special
license requirements needed by some BSPs.  Update the documentation to
reflect the current BSP licensing mechanisms.

Also add a new blurb about the time-limited kernel."

                                  - Tom Zanussi

I applied this patch verbatim and will check and clean up text
as needed.

(From yocto-docs rev: d05a7ddbc0d6017e5a8be2b3e0117f53e30a204b)

Signed-off-by: Tom Zanussi <tom.zanussi@intel.com>
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-23 14:24:50 +00:00
Scott Rifenbark 333f776d6c documentation: Updates for [YOCTO #1717].
Minor edits to the BSP Guide, the Development Manual, and the
Kernel Manual to address [YOCTO #1717], which noted confusion
over the kernel manual when a user was trying to find kernel
configuration information.

The fix for this bug involved several areas.  I had previously
created a new section called "Kernel Configuration" in the kernel
manual and "Configuring the Kernel" in the YP Development manual.
There were several rounds of feedback from Bruce Ashfield.

This commit represents the final touches on the three manuals to
address the bug.

Fixes [YOCTO #1717]

(From yocto-docs rev: de8f85753ad1d6dde66adb6bb4cb09e9528c7cd6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-23 14:24:44 +00:00
Scott Rifenbark 7c12cb1183 documentation/bsp-guide: Converted links to use poky.ent variables.
(From yocto-docs rev: 5a95fd07deed0c118529b7890857850308b4b5ab)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-23 14:24:42 +00:00
Scott Rifenbark eb829f2768 documentation: Section change and cross-reference fixes
I renamed the "BitBake Layers" section in the YP Development
Manual to "Understanding and Creating Layers."  Renaming the
section broke three cross-references in the YP documentation
manual set.  I applied fixes to the references.

(From yocto-docs rev: 93f4f5dfb61ed48047a40f5bbbc3f5e844c7c2f4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:08:06 -08:00
Scott Rifenbark 6aeeeba08f documentation/dev-manual: Added anchor point and edits to kernel config
I added a reference anchor to the spot in the dev-manual for the
"Yocto Project Source Repositories".

Other changes were to the bsp guide and were general edits to the
"Linux Kernel Configuration" section.

(From yocto-docs rev: def35923199d48c879ff06a68f81b5cd28d55185)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:08:04 -08:00
Scott Rifenbark 758dd351a7 documentation/bsp-guide/bsp.xml: Edits to Misc Recipe Files
I added a bit more to the note about BSPs that do not have a
formfactor entry.  The note was vague.  Explanation provided
by Tom Zanussi.

(From yocto-docs rev: 997832850cf01d83bf3b799a5a6e7f5c902d9a8f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:08:03 -08:00
Scott Rifenbark 2027c9616e documentation/bsp-guide/bsp.xml: Edits to Display Support Files Section
(From yocto-docs rev: c888c1c82dea615175bdb8818409a264d0c749ee)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:08:02 -08:00
Scott Rifenbark cfbee010ac documentation/bsp-guide/bsp.xml: Edits to Core Recipe Files section.
(From yocto-docs rev: 8bd330a4d43732a10c4801f27a969adc83ac0e97)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:08:02 -08:00
Scott Rifenbark e856eed4e3 documentation/bsp-guide/bsp.xml: Edits to HW Configuration Options Section
Made some minor edits.  I also discovered that the information
describing where tuning files reside was not real helpful.
In particular, tuning files are not limited to the
meta/conf/machine/include directory.  For example, the Crown Bay
BSP layer includes a tuning file from the meta-intel Layer.

(From yocto-docs rev: 3a76ccc4f645f03a6e888b7eb53fa9bc7bfb255e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:08:02 -08:00
Scott Rifenbark d035bb875f documentation/bsp-guide/bsp.xml: Edits to "Layer Configuration File" section.
(From yocto-docs rev: 78d36baa57fe9c95bdd39eb63a5bada6a1a5ee64)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:08:02 -08:00
Scott Rifenbark 93ad9b5f00 documentation/bsp-guide/bsp.xml: Edits to pre-built user binaries section.
(From yocto-docs rev: 1bf460e980ee35e783a64de2cddfdd68c5471871)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:08:01 -08:00
Scott Rifenbark 1764713763 documentation/bsp-guide/bsp.xml: New "README.sources File" section added.
(From yocto-docs rev: 2f398b278904b26e4cd6ab237c0c9dce7e8d6009)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:08:01 -08:00
Scott Rifenbark 011738ac7a documentation/bsp-guide/bsp.xml: Edits to point to files
I was introducing each area of the sub-sections by saying
"You can find these files in the Yocto Project Files ....",
which really isn't accurate.  This structure is a BSP structure
or layer.  I am not referring to it as such.

(From yocto-docs rev: f13a89bc7812106abd4ef95dfdccfa48eae11af6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:08:01 -08:00
Scott Rifenbark be04e176cb documentation/bsp-guide/bsp.xml: changes to Crownbay example
I brought the example Crown Bay structure up to speed with the
state in the YP source repositories.  I also made a couple minor
edits.

(From yocto-docs rev: 23dbd76952c79b1b3a28b731bef218f4cabfd8fb)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:08:01 -08:00
Scott Rifenbark 4dd2dc9886 documentation/bsp-guide/bsp.xml: Edits for BSP Layer understanding
I added a small section at the start of chapter to define a
BSP Layer, note where the YP keeps them, and note that meta-intel
is somewhat of a "super" layer as it contains several BSP layers
of its own.

(From yocto-docs rev: 2e044072660d3f675612e01e3871d6a4fb0894bd)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:57 -08:00
Scott Rifenbark c74f732576 documentation/bsp-guide/bsp.xml: qualified the commit ID difference
In the example that shows the linux-yocto_3.0.bbappend file the
commit IDs are pretty much random and taken at the time I wrote
the section.  I have provided a qualifying statement before the
example to explain that the commit ID strings in the manual's
example could differ from those in the actual file in the YP
source repository.

(From yocto-docs rev: f31278a7ebc4271a6cb75da6891d2d9bf82d41f3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:53 -08:00
Scott Rifenbark 3ecda3fb02 documentation/bsp-guide/bsp.xml: Updated reference to manual
The reference for changing a BSP configuration was going to the
kernel manual.  This was an old reference.  That information had
been pulled from the kernel manual and is now in the BSP appendix
of the YP Development Manual.  I updated the reference to point
there.

(From yocto-docs rev: 20b386c522b1fedc2249ac72f151192ff69d098a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:52 -08:00
Scott Rifenbark 0bc0d3529a documentation/bsp-guide/bsp.xml: Updated commit IDs
Crownbay commit ID's used in the example did not match what
is in the YP source repository for meta-intel.  I updated them
to match.

(From yocto-docs rev: c090119f59b9f1fe8caebeea8ba61c6c1252a892)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:52 -08:00
Scott Rifenbark 9dc84b77ec documentation: Cross-referencing section fixed for consistency.
(From yocto-docs rev: 8e861c6fc07aefa81ff65e3542de855116e14969)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:52 -08:00
Scott Rifenbark 684c35b7aa documentation: Changed all manual links to point to "latest"
There are many references to YP documentation throughout the
YP manual set.  They used to have hard-coded links to the
current release (e.g. yoctoproject.org/docs/1.1 for Edison).
This created a situation where if you went to a document on
the website and clicked on a external reference to another
manual, you would redirect to the current manual on the website.
Really, you would want to go to the latest manual, which is
one that is under development.  Changing the links to
"yoctoproject.org/docs/latest" makes the tip of master, which
is used for devloping the next release, always have references
to the manuals being developed and not back to the stable
released set of manuals.

This "latest" and "current" scheme for the links is not perfect.
What has to happen when the latest set of the manuals freezes
and becomes the next stable release, all the links in the docs
will need to be changed from "latest" in the URL to the new
release number.  So for example, all the "latest" occurences
would need to be changed to "1.2".  Then for the next cycle
as development begins again, the links need to be infused with
"latest" again.

(From yocto-docs rev: a234aef34303b07671da956de0e94b352797143e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-11-25 15:24:17 +00:00
Scott Rifenbark 02e5570bc1 documentation/bsp-guide/bsp.xml: fix link - found by Robert P. J. Day
As Reported by:  Robert P. J. Day.

Broken link to the YP website's Download page.  Fixed.

(From yocto-docs rev: cffba12b611a350652cb7ae0c49c6a6c809593df)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-11-08 16:26:32 +00:00
Scott Rifenbark 2923cc23d1 documentation: Cleaned out bad links and replaced with good
The re-structuring of the web server that holds the documents created
some bad links.  I thought I had gotten them all but apparently not.
this is a drawback of not being able to test things until after stuff
is done.  In any case, I grepped through everything and this takes
care of it.

(From yocto-docs rev: cdbc3b3b7f6d6ff01024b977f966459cf414ad5c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-14 00:31:11 +01:00
Scott Rifenbark 43eeb4f870 documentation/bsp-guide/bsp.xml: Added recipes-core section
In the example I use for the BSP structure I use the Crown Bay
BSP.  I neglected to include any explanation of the recipes-core
directory.  I have added some description around this area.

(From yocto-docs rev: ba56c86e5a4aa3fbf23b12d26ffe35a3b6193a78)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-04 13:46:40 +01:00
Scott Rifenbark b214cdc7e8 documentation/bsp-guide/bsp.xml: Edits for Crownbay example in kernel recipes
Because the Crownbay uses both EMGD and non-EMGD statments in the
linux-yocto_3.0.bbappend file I had to do some explaining.  It turns out
you don't really need to just delete or comment out the non-applicable
statements.

I also adjusted some wording around the tuning file example.  This file
I assumed was in the conf directory of the meta-crownbay directory.
It is really in the meta/conf/machine/include directory.

(From yocto-docs rev: 3f82656f7ffb392333f8cf59abf1414af5da512b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-02 23:38:51 +01:00
Scott Rifenbark ca975f5fba documentation/bsp-guide/bsp.xml: Removed directory class
(From yocto-docs rev: d0fde36b445dc674888cb521347fcff8cd670436)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-30 17:27:39 +01:00
Scott Rifenbark 748afbad90 documentation/bsp-guide/bsp.xml: Scrubbed Crownbay items.
The file used a lot of crown bay stuff that had gone old.
I have updated the sections and used the latest Crown Bay
files.

(From yocto-docs rev: 67b119d66bacd0870f18a124bacabf32d65b6f3b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-30 17:27:39 +01:00
Paul Eggleton e4e0d026c1 documentation: typo, spelling & minor grammar fixes
(From yocto-docs rev: a5b069b04979a566b08415cf27af2ad6abf90f2f)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:49:35 -07:00
Scott Rifenbark 31d594802f documentation/bsp-guide/bsp.xml: General updates
I added a parallel textual construct at the beginning of each section
that details a directory in the Yocto Project file's structure.
I did not like starting these sections with a literallayout string.

(From yocto-docs rev: 5dde476f0c02d655217f3fa863522e8b7df57cda)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:04 -07:00
Scott Rifenbark df7b4f1648 documentation/bsp-guide/bsp.xml: Added a note stating no example here. (From yocto-docs rev: 1373b315bbe875840a75a80ea688eb025b6d80a1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-07-21 10:59:21 +01:00
Scott Rifenbark 0a29457396 documentation/bsp-guide/bsp.xml: Changed 'GIT' to 'Git' (From yocto-docs rev: c77a003b7c5410c1a9a4e8d3437b829c5dc07391)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-07-21 10:59:21 +01:00
Scott Rifenbark 762c0d001f documentation/bsp-guide/bsp.xml: updated path for yocto kernels
changed 'meta/recipes-kernel/kernel' to 'meta/recipes-kernel/linux'
as the location for existing YP kernels found in the repository.

(From yocto-docs rev: c8ce3a15429df5c980498ce217803cf5a59cbdc9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-07-21 10:59:21 +01:00
Scott Rifenbark 651119a4ef documentation/bsp-guide/bsp.xml: Scrubbed "Poky" out of the manual. (From yocto-docs rev: b5e3c58dbdc82579920de07e8c1c76cfa42596a7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-07-21 10:59:21 +01:00
Scott Rifenbark 189fa6b9bf documentation/bsp-guide/bsp.xml: Updated Example Filesystem Layout
Added more explanation about the base directory (meta-<bsp_name>) to the
Example Filesystem Layout section.  These changes were suggested by
Tom Zanussi to help users understand better how to add BSP layers
to the build system.

(From yocto-docs rev: ced445910363b2f10b5b5ca72236f54ae4b7e050)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-05-17 20:07:48 +01:00
Scott Rifenbark dd3cd02e29 documentation/bsp-guide/bsp.xml: Updated link to BSP Download site
In the 'BSP Click-Through Licensing Procedure' section there was an
old link to the BSP download page on the Yocto Project website.  The
link was non-functional.  I fixed the link so that it points to the
Yocto Project BSP Download page.  I also re-wrote the paragraph to
read better.

(From yocto-docs rev: b87714fa54f71aa061126b7f29d80723a90818e8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-05-17 18:14:06 +01:00
Scott Rifenbark a106f4145c documentation/bsp-guide/bsp.xml: Updated /binary explanation
In the '1.1.3 Pre-built User Binaries' section it said that the
ADT and minimal images were kept in the optional
meta-<bsp_name>/binary directory.  Jianjun Xu pointed out that
in fact it is just the minimal and sato images here.  I also
confirmed with Tom as well.  I re-wrote this sentence to be
clearer and more accurate.

(From yocto-docs rev: 6757abff52841b5d1e1991ab22314fa7a243a87d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-05-17 18:14:06 +01:00
Scott Rifenbark cf3d261f3e documentation/bsp-guide/bsp.xml: BBFILES statement corrected.
In the '1.1.4 Layer Configuration File' section there was a BBFILES
statment that used the '\' character to indicate a continuation of the
command on the following line.  However, the example did not use
a new line.  I added the hard-return to correct that in the example.

(From yocto-docs rev: 185352ae2f5879a8418715053f3791b167bd6d7e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-05-17 18:14:05 +01:00
Scott Rifenbark 211d5a3fba documentation/bsp-guide/bsp.xml: bsp exmaple name fixed
Changed the example BSP name 'meta-intel_n450' to 'meta-n450' in
the section 'Example Filesystem Layout.'  Error found by Jiajun Xu.

(From yocto-docs rev: 0dd6f97dcc51cec4bae96ca0430af9300619749f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-05-17 18:14:05 +01:00
Richard Purdie e9b17e3fa7 Rename poky-image-* -> core-image-* and task-poky-* -> task-core-*
(From yocto-docs rev: 0feb6b8f9621087ba5fd77d3c8f3e23132c97187)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-04-21 13:08:45 +01:00
Scott Rifenbark eab4c5cf07 documentation/bsp-guide/bsp.xml: Spell check
Performed a spell check and caught a couple small things.

(From OE-Core rev: 17ae7d1e05df495a5e27168cdcdfbcf96337a3f9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-18 16:47:59 +00:00
Tom Zanussi 5ef65bd112 documentation: BSP Developer's Guide fixes
- use linux-yocto instead of linux-yocto-stable in examples
- change branch names to match linux-yocto usage
- remove outdated 'wrs' where it appears

(From OE-Core rev: 7f1662ef01b383c9fecb2b30ade50de97f17529a)

Signed-off-by: Tom Zanussi <tom.zanussi@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-14 21:08:37 +00:00
Scott Rifenbark 7d4fd5f70a - documentation/bsp-guide/bsp.xml: Re-write of click-through
[BUGID# 553] - In the 'BSP Click-Through Licensing Procedure'
section, which is shared between the BSP Guide and the Poky
Reference Manual, there were three links to 'pokylinux.org'
sites.  These links were intended to help a user get a license
for encumbered BSPs.  However, the links never did work.  The
section also had some wording that described a propsed naming
convention for BSP tarballs that were encumbered and non-encumbered.
The naming convention is a good idea but has not been followed
so far.

I removed the links and replaced them with general instructions
on how to get through the licensing situation.  Also removed the
hard-line naming rules and replaces with a more general explanation
of how we are naming BSP (e.g. Crown Bay).

(From OE-Core rev: 4c2dcb376b4be0778cab97138fefdb8a27a0e708)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-03 16:56:13 +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 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
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 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 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 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 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 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 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