Applied "Metadata" for "metadata"
Added a link to the section to help find maintainers.
Some re-wording.
(From yocto-docs rev: 7f40c4dac30d2f54cf09afeb51a5cc83ba0851e9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The list was missing several of the linux-yocto kernel types.
(From yocto-docs rev: a91d26ad3a340c54d807458766b7d4f1754df7c2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a note in the bsp-guide to point back to the main
new section, which is in the dev-manual.
Made some small edits to the main section in the dev-manual.
(From yocto-docs rev: 4105c8edbdc531b2a941d7f7282325fae763f059)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Performed some spelling checks against the files associated
with a large number of patches sent by Paul Eggleton.
(From yocto-docs rev: 8b16924aa1da161271cbfce5410344d94c840fa6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This was pointing to the old 4.47 file even though the rest of the
references in this section used 5.0.
(From yocto-docs rev: 42c2a0262b316ac25ad3a413f925e94cabae4553)
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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>
