Commit Graph

162 Commits

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