* BBFILES should be appended to with +=
* BBPATH should be appended to with .=
* Immediate expansion is not necessary for BBFILE_PRIORITY
* Immediate expansion is not necessary for references in layer.conf
to LAYERDIR since these are automatically expanded at the end of
parsing the file (and have been for some time).
* Add collection name override to BBFILE_PRIORITY example
* Fix comments referring to old structure ("packages directory" or
"recipes directory")
(From yocto-docs rev: 0aaac8f5ad97c802ebe1d4f3ffb7987050533292)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes YOCTO #3552
Added some links to the FILESEXTRAPATHS and SRC_URI variables.
These links connect appropriate sections to a newly improved
section on FILESEXTRAPATHS glossary description.
(From yocto-docs rev: a58e7c6f013393c87381411f918e16a8f04d55d1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Hi,
the generation of eclipse help files has been merged from the timo
branch to the master. Since the creation of the timo branch there have
been some changes to the master branch (e.g. new documentation,
renamed documentation).
This patch set does some cleanup for the renamed documentation and
adds eclipse help generation support to the new documentation.
01: Removes the 'the' from the document titles
02..04: Cleanup obsolete artifacts resulting from the merge
05..08: Add eclipse help generation for ref-manual
09..13: Add eclipse help generation for kernel-dev
14..18: Add eclipse help generation for profile-manual
Best regards,
Timo
This patch set originally contained 18 patches. I (Scott Rifenbark)
had to push these changes as two parts. This is the first part.
It does not include creation of the three cusomization files.
(From yocto-docs rev: 9b1889f6e31ee70dae704fa08763fb9196616dad)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The chunk.quietly option disables the output of the docbook
chunker. Creation of a new html file is now longer printed to the
console. This provides a much cleaner output of the eclipse makefile
target.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The title of the document used to create metadata for output formats
such as eclipse help.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This stylesheet uses the eclipse stylesheets of docbook to create
eclipse help from this documentation. In addition to simple html
files these stylesheets will also create xml files which are
needed to integrate the documentation into eclipse (e.g. toc.xml).
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Standard stylesheet parameters were moved to the docbook customization
file tying them to the docbook stylesheet used. Removing these
parameters simplifies the Makefile.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #3176]
Several places throughout the YP manual set examples are given
for the bblayer.conf file. For release 1.3, a bug existed that
surfaced when a user removed either the meta or meta-yocto
layer from this configuration file. The bug has been fixed and
the ripple effect through the YP documentation set affected
several manuals.
Fixes include updating the code samples that show bblayer.conf
so that they now include the BBLAYERS_NON_REMOVABLE variable,
a new glossary entry for the variable, and an explanation of
both BBLAYER and BBLAYER_NON_REMOVABLE in the section that
talks about the bblayer.conf file.
(From yocto-docs rev: 904b9ec1cd6d823af0e92f6891fc7e434cf2e358)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Made changes to the poky.ent file to change the three variables
needed to build manuals for 1.4.
Made new entries in the manual revision history tables for the
five manuals that have them. Each entry shows the "TBD" release
coming up.
(From yocto-docs rev: f7f75a238d709698f1582ce22e209c09ee60581b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated some example text based on the latest source
repositories for crown bay. Replaced fishriver example with
fri2. Updated some capitalization usage for source directory
and build directory.
(From yocto-docs rev: 65973f7b30699fbb82b4d7f1b907e947489ba7d0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
One change resulted in changing out "include" for "require"
in code from the Crown Bay example.
(From yocto-docs rev: 69b21d5f62ad9020646a26ce13d349af50aee419)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the release month in all the manual revision history
tables to say "October 2012" from "Sometime in 2012".
(From yocto-docs rev: 1fc9313fe6c69db3d8cece6d940f78a2f0dc8386)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The kernel workflow section was re-written to reflect that the
kernel appendix has been removed. Also, changes to the flow in
general no longer make reference to the bare clone and the copy
of the bare clone as a method used to modify the kernel.
Many links were modified in other manuals as well.
(From yocto-docs rev: 38adbcb00d4305029cfa94e5ef047da41823f021)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The kernel example appendix is being removed. This broke a lot
of links. For now I have moved the information into a new section
called "Patching the Kernel". I have preserved the information
by adding the old appendix file as kerne-appendix-orig.xml.
(From yocto-docs rev: 994235a69362dfb0114ef9001ea7f2f2e2fdc5c3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removing the Appendix A (BSP) example had some rippling affects
throughout the doc set. There were several links into the appendix.
All these links had to either be modified (if possible) or simply
removed since the appendix will be removed.
(From yocto-docs rev: fff35abd87e945de1806eef63a56a956d104bf92)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I did a walk through of the "Using the Yocto Project's BSP Tools"
section. Updated included altered output based on the current
example commands and scenarios.
Also made changes to the bblayers.conf file as the default
version for this file has changed.
(From yocto-docs rev: d8a2195e37d8f96702026e42bb43daf39852ffcb)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The term should be initially capitalized.
(From yocto-docs rev: 38a11d512bfe675319fb76da9d7618315af91c47)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The meta-intel BSPs and yocto-bsp tool no longer use a bbappend of
task-core-tools-profile to add systemtap, so these sections should be
removed.
(From yocto-docs rev: cdc12163dd95f0a78cc0f35c03b5eb3d7b1476e3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed "The" from all the titles of the books. This makes it easier
to reference to them and easier for the automated processing of the
mega-manual.
(From yocto-docs rev: af566d6d007cff642648698ea487a6eeaa8cc930)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I fixed several occurences of cross-references to whole manuals where
the formatting was split in the <ulink> statement. The <ulink> tag
and the manual title must be on one DocBook line in order for the
sed scripts to correctly process the links when the mega-manual is
created.
(From yocto-docs rev: 0dee12d518c892f59c0446e1c7b5d0f71b6ee22b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
the title in the note about production process was technically
wrong. I added in "Yocto Project" as part of the title.
(From yocto-docs rev: c421f02549b8ca203d1c9f747870911c59bda96c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
the notes that say "Due to production processes..." at the start of
each manual contain links to manuals. the links needed to be formatted
such that the entire <ulink> code and manual name appeared on the same
line so that the sed script can effectively remove the link in the
resulting mega-manual.
(From yocto-docs rev: 0a41971c331ad1961e6ee1e067b59c36c9f048f6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The references to the YP Development Manual were inconsistant.
These references were fixed.
(From yocto-docs rev: f4ded0b965fcbce7b500ca21886ee9b755c38383)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I had to rename individual style.css sheets to have book-specific
names. So style.css for the ADT manual becomes adt-style.css and
so forth. Turns out, this isn't really necessary for the solution
to create the mega-manual but I am leaving the changes as a
separate commit because it makes sense. It causes no disruption
to making the six YP manuals.
(From yocto-docs rev: 8cbdae1fe86988243f91dfd611c14f8a37007886)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
With the creation of a new KMACHINE glossary item, there were two
areas in the YP doc set that reference the variable. I added
cross-reference tags. Also noted that some other references
were missing to the variable COMPATIBLE_MACHINE.
(From yocto-docs rev: f740b62be175a50f17ce8a244258dcf391fcf672)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I have updated both the section for configuration fragments found
in the BSP and dev manuals.
Reported-by: James Abernathy <jabernathy@gmail.com>
(From yocto-docs rev: 62f4df751c80e7b749356bb80ade3a7847411f7c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
final changes to the section that talks about configuring the kernel.
Changes here based off Bruce Ashfield's review comments.
(From yocto-docs rev: 7715643f2a24336585dd44d1d75e7be0aade7f6b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some work in progress.
(From yocto-docs rev: d344b2db75c21bc7050e4a5f70c07ffd8f7545de)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I missed a "Yocto Project Files" term because the damn thing split
across two lines in the source file and my grep method did not find
it. Changed it to "source directory."
(From yocto-docs rev: 31a261c141d3e26f4a87b9725097005c96345e2e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Pared down the use of the term Yocto Project.
(From yocto-docs rev: d62747ca1d42cae703d1cd307dfe16bb9682b741)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added a small review comment to the section based on reviewer
feedback.
(From yocto-docs rev: 68cc2bac8dca78572d197af326452bbd37c947f9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
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>
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>
Added entries for the Manual History table for upcoming 1.3 docs.
(From yocto-docs rev: 430b384035593cd05c4f286e20c01f0fe72da8ec)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
After some discussion from Song and Richard, the dates in the
manual revision table has been updated to "April 2012" for the
1.2 release.
(From yocto-docs rev: b3fc2ec7c5aedb8ea0a2d502bdcd7e8f4092ed96)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Five tables updated for the five manuals that have the tables.
Used "May 2012" as the date.
(From yocto-docs rev: 0d4d46ba300c07ff9c73186506be5b409bef9d1b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
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>
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>
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>
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>
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>
Paul Eggleton
Scott Rifenbark
Timo Mueller
Robert P. J. Day
Tom Zanussi
Beth Flanagan
Saul Wold
Richard Purdie