There needed to be an entry in all the manual history tables
that indicated this version of the manual is for 1.2 but is
WIP.
Reported-by: Rudolf Streif <rudolf.streif@linux.com>
(From yocto-docs rev: 6792b88af4f0171cfc84e4d77bda871d4af3d36c)
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>
Updated all the CSS style sheets so that the Note, Warning, Tips,
Caution, etc. boxes are not so prominant.
(From yocto-docs rev: 451568553e9620c1e247c2f67b0665b184c3300b)
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>
During development, a footnote was added to the Development
manual. In order to get the footnote to display correctly, I
had to introduce a footnote element in the style sheet. This
commit propogates the style to the other manual CSS sheets.
(From yocto-docs rev: 0439b46620125f2cb26dff4e8c79fc479205133a)
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>
Updated the title pages for the ADT, BSP, Dev, and Ref manuals to
contain the Oct 6 release date for the books. Also, changed the
author field for the BSP guide to include Tom Zanussi as well
as Richard Purdie.
(From yocto-docs rev: 301da0a5b305e4b332397bb67f6a6a77751991d2)
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>
Paul sent me a bunch of minor edits and technical corrections
for the ADT, BSP, Development, and YP reference manual.
Most changes were taken as he submitted them. However, some
formatting conventions were not followed in the commits he made
to yocto-docs/paule/docs2. After merging them to my yocto-docs/master
branch I fixed some issues.
(From yocto-docs rev: 93f4ea2dee976448f623953e801a80d59736450a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These documents do not have titles when showing up on the website; set
the title tag value so that they do.
(From yocto-docs rev: baf958e3f49317689275b14dd31c6141f36c8c65)
Signed-off-by: Paul Eggleton <paul.eggleton@linux.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>
Note mentions possible differences between docs in the released
tarball and docs on the website. Suggests website for latest
docs.
(From yocto-docs rev: 1b729667498363a5bb451502975b0797796eea0b)
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>
I added an entry to represent the Yocto Project 1.0.1 Release into
the manual history table for all of the manuals except the Yocto
Project Quick Start, which does not have a table.
(From yocto-docs rev: d2c570b18854b3f15dfb20436a2212f569e96d5f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These changes fix the following issues:
1. Multiple Makefiles. There really is no need for this.
2. Unable to maintain more than one version of the docs on the webserver.
This is a quick fix to enable the above.
In order to build the documentation, at the top level, issue a:
make all DOC=<doc directory name>
make all DOC=kernel-manual
Also, some changes need to occur on the webserver to fully
incorporate these fixes.
http://www.yoctoproject.org/documentation/
The docs are now published to:
http://www.yoctoproject.org/docs/<Release MM.mm>/<doc name>
The main page should be changed to point not only to the current doc release,
but also to the prior releases. This will enable us to maintain prior release
documentation without stomping over it when we publish new docs. Also, we'll
need to repoint the yocto-quick-start link to yocto-project-qs. Or rename
documentation/yocto-project-qs/* to support the website naming.
(From yocto-docs rev: 2651790d80fd32cd4619eeb5375f6ee28e7e7fda)
Signed-off-by: Beth Flanagan <elizabeth.flanagan@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>
I removed the hardcoded name from the publish option. This involved
updating the Makefiles. The publish option is still temporary as a
more permanent solution is being created.
(From yocto-docs rev: 6878b2ccdb98b18c438ca419e1caad0041a2bc00)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
BUGID#_956: I updated the Make file so that it will push the HTML and PDF files
automatically to the yocto project site. This takes care of
BUGID#_956 for the BSP Guide.
(From yocto-docs rev: 684f1836056c977c08a27a0a80d622e360977919)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed this figure as it is not used in the manual.
(From yocto-docs rev: 6fa2c18a7ea647386a113e0e50860d66ecb83e4a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added the URL for the manual to the rcp publishing process. This
is part of the fix for this bug.
(From yocto-docs rev: 4d25c5e1cd6f0b067d0a88fbde1ac6df7066dfa4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
For some reason the PDF version of this manual was not being included
in the tarball created by the Makefile. I fixed this.
(From OE-Core rev: f8ec09ab31c04b2ae9570b71174f50c58ad09f00)
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>
I updated the HTML style sheet to match that of the other online
manuals. Section heads are now in Yocto blue and tip box
color is inline with Yocto color schemes.
(From OE-Core rev: 815b71a6c66e529959a12bd9aa6aabc0afc78bb1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the revision table for the manuals to have better
wording and to go from oldest to newest top down.
(From OE-Core rev: 7a4f802bb4d12f863a13fc4ba095a3de149aa6df)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the figure for the title so that it uses the same color
scheme as the other manuals.
(From OE-Core rev: 23c40367c56e838bb9c1ad89cec8ca2e563a40a7)
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>
I updated the revision history on the title page to reflect the upcoming
Release 1.0. I will likely have to change this as we get nearer the
release so I can be sure of the number and also add meaning release
remarks to the entry.
(From OE-Core rev: 5ba502311221c3a476465d148fcfecf557fbfe79)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed the email address for Richard Purdie in the author title
page to richard.purdie@linuxfoundation.org.
(From OE-Core rev: 86e355f489437c4d20a717617d203a8a5aa1371a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
[BUGID# 695] - I updated the title to use a less bold and intrusive
font and one that is still common for systems. Also removed the
"s" in the title so it now reads "Board Support Package (BSP)
Developer's Guide." I also put a better looking Yocto logo in.
Once this commit is merged bug #695 can be marked resolved.
(From OE-Core rev: f6d9338bf98f2f6791231a5ff74142833ae1363e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
Because I created the file 'bsp-guide-customization.xsl' to try and eliminate odd
HTML runtime errors and to allow for customized XSL layer of formatting, it was necessary to
update the Makefile to call the new file as the XSL style sheet.
The Yocto Project Quickstart uses this technique and has no HTML build
problems.
HTML build errors seem to be eliminated so far.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Since the BSP Guide is under its own cover I thought it would be good
to have its title page not have the Poky Handbook PNG image. I created
this BSP image for use with the stand-alone BSP Guide.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
I created the file 'bsp-guide-customization.xsl' to try and eliminate odd
HTML runtime errors and to allow for customized XSL layer of formatting.
The Yocto Project Quickstart uses this technique and has no HTML build
problems.
HTML build errors seem to be eliminated so far.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
I am getting occasional errors while attempting to make the HTML version
of this manual. The error is generated from line 367 of the html.xsl
style sheet and seems to come from confusion of not finding the css
style sheet parameter. Here is the error from the shell window.
scottrif@scottrif-desktop:~/poky/documentation/bsp-guide$ make html
xsltproc --stringparam html.stylesheet style.css --stringparam chapter.autolabel 1 --stringparam section.autolabel 1 --stringparam section.label.includes.component.label 1 --xinclude -o bsp-guide.html http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl bsp-guide.xml
Note: namesp. cut : stripped namespace before processing
WARNING: cannot add @xml:base to node set root element. Relative paths may not work.
Note: namesp. cut : processing stripped document
runtime error: file http://docbook.sourceforge.net/release/xsl/current/xhtml/html.xsl line 367 element choose
Variable 'generate.css.header' has not been declared.
make: *** [html] Error 10
The odd think is that running "make html" immediately again could cause the
make to be entirely successful.
So this commit involved moving the XSLTOPTS parameters to the top of the
make file and the *_URI parameter declarations to the top as well. This
takes them out of the "pdf" area of the make file and they should be
more universal. The reason I tried this is because I have no such issues
when building the yocto-project-qs HTML file.
However, even with these changes the occasional runtime error (shown above)
still occurs.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Since this manual is about BSP and not Poky as is the Poky Reference
Manual I updated the title page to include the title combined with the
Yocto Project logo. So for the background-image url in the .authorgroup
style I replaced the poky-ref-manual.png file with bsp-title.png.
Updates affect both the PDF and HTLM versions of the BSP Guide.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Since this manual is about BSP and not Poky as is the Poky Reference
Manual I updated the title page to include the title combined with the
Yocto Project logo. Updates affect both the PDF and HTLM versions
of the BSP Guide.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Since this manual is about BSP and not Poky as is the Poky Reference
Manual I updated the title page to include the title combined with the
Yocto Project logo. Updates affect both the PDF and HTLM versions
of the BSP Guide.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
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>
Scott Rifenbark
Tom Zanussi
Paul Eggleton
Beth Flanagan
Saul Wold
Richard Purdie
Darren Hart