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>
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>
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>
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>
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>
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>
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>
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>
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>
"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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
- 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>
[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>
Robert P. J. Day
Scott Rifenbark
Tom Zanussi
Paul Eggleton
Richard Purdie