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>
Fixes YOCTO #2684
Applied some review comments to the section from Richard
Purdie.
(From yocto-docs rev: 772617a45df10e5e42364854fe03d8aad7cb46b6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These types of links must not span multiple lines in order for
mega-manual to process them.
(From yocto-docs rev: bcea042cd796a51d866f82399b2fd0cc89ec9e2b)
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>
Added a bulleted list to the "Terms" section to help define
some toolchain recipes such as gcc-cross-initial,
gcc-cross-intermediate, and so forth.
Added a cross-reference link to the term
"Cross-Development Toolchain" in the the "Working Using
Stand-alone Cross-development Toolchains" section.
This gives the reader a way to see more on the toolchain
recipes.
(From yocto-docs rev: 2cb612424c0cf6addfd8bce8a0ef77665c35bd9a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Received a patch from Robert P. J. Day but deleted it from
my Thunderbird account so could not apply it directly.
I applied most of his corrections. A couple I left alone.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 2cadd5265fcb5cc281c22ccae81260a6633229e2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes YOCTO #3664
Added some information in the note to point out that not all
append files add files into the mix. Some just exist to add
build options. And, in this case the _prepend part of the
FILESEXTRAPATHS statement is not necessary.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 388c441341006227be2f9e7d42bb1c509c32790d)
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: 3272f0d51e3d09f4ffd96b7322f66ffd878d3714)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Two things fixed:
1. A couple examples for setting up a layer.conf file were
using the meta-yocto configuration file as an example.
Turns out this is a bad example because the BBPATH variable
is appended to the LAYERDIR when setting BBPATH rather
than the other way around. That is because meta-yocto
is a distro layer. BSP layers, however, are not distro
layers and are the norm here. So I switched up the way
BBPATH was set and actually called out meta-yocto-bsp
config file as a template.
2. Added a link for the BBPATH variable in the
FILESYSTEM_PERMS_TABLES variable description in the
glossary. Just happened to notice this so I fixed it
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 1a594b6dde1a494a5f7322b510e1e67d23635298)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes YOCTO #3662
I added more information to the variable desription in the
glossary for BBMASK. The information included a bit more
syntax information as well as some more complex examples.
I added more reference information to the "Excluding Recipes
From the Build" section to help better describe how the
BBMASK variable works.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: f10f43a543e7b0892863e165d2902741a8823009)
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>
Updated a couple spots in the manual to be clear on meta
not being a strict requirement for a layer name.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: ffd80ade292a462a77981c8c19bb71a19333a397)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes YOCTO #3663
I added wordings to indicate that meta-intel is not required
to create a BSP layer. But, the example presented uses
meta-intel.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 746948cd1d612f0b837e70a7e92e4081d379cb50)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Part of section 5.15.1 incorrectly implies that only copyleft
source will be archived to the specified directory, when in fact
copyleft filtering is disabled by default.
(From yocto-docs rev: 8eacef8acc398bc3d881d657d27c8827f05e3227)
Signed-off-by: Kevin Strasser <kevin.strasser@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The example doesn't account for an extra level of directories
that organise the sources by machine type.
(From yocto-docs rev: 844e8b8f28ab765e59fdbee40e00c973b1b00d89)
Signed-off-by: Kevin Strasser <kevin.strasser@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I went through and got rid of all references to the old
YP Kernel Architecture and Use Manual and replaced with
appropriate references to the new YP Linux Kernel
Development Manual.
I also laced in appropriate references into various sections
of the new YP Profiling and Tracing Manual.
Also, updated the list of resource manuals to reflect the
new manual set (addition of kernel-dev and profile-dev and
removal of kernel-manual).
(From yocto-docs rev: ef531ad65c9b749dad5e8e39b060bf1641e4fa38)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the "Terms" section, I enhanced the "Metadata" term to include
a bit about Metadata in the context of the kernel. This type of
metadata is discussed at length in the YP Linux Kernel Development
Manual.
(From yocto-docs rev: c6f48bc4c33850eaa1dbf5867759a19d373766ce)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Robert P. J. Day suggested adding http://lists.yoctoproject.org/
listinfo to the list of mailing lists, which included yocto,
poky, and yocto-announce.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: f322c60814471e4216e112b193e5769fd6008a79)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
1. Added "Debian" as a distribution for best results.
2. Fixed a link to the Hob page and two links for the
Build Appliance.
3. Three typos fixed and a few grammar items fixed.
(From yocto-docs rev: 0b381094ed9cc2d66895d4ad7c63005c8a918eb1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated a note that points the reader to the maintainers list. The
note in the master branch pointed the reader to a nonexistent (old) file.
(From yocto-docs rev: d947d6d9bd42562a84ad3ac90e4c2052f421119c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
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>
Fixes [YOCTO #3445]
Updated the "Installing the Plug-in Using the Latest Source Code"
section for the Eclipse section. This was pretty much out of
whack. I have created new steps that involve running the setup
script and then running the build script. The new information
still needs a review.
(From yocto-docs rev: 5903964a9583c6051abefa4a7b944b59a76825b4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #3274]
I have added a new area at the bottom of the current
"Using the Yocto Project in a Team Environment" section.
This section is the spot for addressing what Richard Purdie
coined as "How to use YP in a work group." For now, the
changes are based on the information that Richard placed in
the Bugzilla entry. Presumably we can build on this information.
(From yocto-docs rev: 92c5d1b6ac6b553fab19410170364dca40123c59)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2909]
Applied a few changes based on Paul Eggleton's review
of the section.
(From yocto-docs rev: 54c2b1577ba062e09a8df14767257147e33a939f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2909]
Updated the "Using a Development Shell" in the dev-manual to note
that the OE_TERMINAL variable is the thing that controls what
terminal is spawned. Added a reference into the new
variable description.
In the poky-ref-manual, I created a new glossary description for
the OE_TERMINAL variable.
(From yocto-docs rev: 25001eba312c4109b4aaa79b334d27e144ef0d3f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2909]
Updated the section on using a development shell
(From yocto-docs rev: 37b43dcb19dda747b7e90ac2e393dad29e9d87a5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO_#3366]
Created a new section titled "Handling Optional Module Packaging"
in the dev-manual. This section is based on the wiki page
that Paul Eggleton authored.
Created a new glossary entry for PACKAGES_DYNAMIC in the
poky-ref-manual.
(From yocto-docs rev: 5af3da5e2af15c33e5e6eb7a9ef3ab3c0923284f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO_#3396]
Spaces in file and directory names is an issue for the build
system and throws an error when sourcing the environment
setup script. I added key notes in several areas of the doc
set. I also added some cross-references to the oe-init-build-env
section in some other areas where running the script is discussed.
(From yocto-docs rev: 1d102e91ba77391096749bd7df6c05b2b695b33f)
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>
Made minor changes as needed due to some new sections, links,
and capitalization standards.
(From yocto-docs rev: bc966e5a78dadd14ecf1896a36e40a9b256bae77)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the sections on the "Git Workflow" in Chapter 4 and
the "Patching the Kernel" section in Chapter 5 per Tom
Zanussi's review comments. Minor technical changes.
(From yocto-docs rev: fd8a291349c06328adebd37f8a9bbeaa49adb44c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
this figure used to be at the end of the development manual.
I have removed it from both figures directories and taken
it out of the TARFILE list in the Makefile.
(From yocto-docs rev: ad8fcfc4bddb6bcee0e1a4ece78cd87ab0d51b6c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Updates to the Git Workflow section based on feedback from
Darren Hart. These changes simplify the flow and make it
generic.
* Updates to the lttng user space tool used from within
Eclipse. The legacy version of the tool is no longer supported
so it had to be edited out of the description and replaced
with the 2.0 version.
(From yocto-docs rev: 81d2b79035fc99f92364bfef2c76076738cbaa52)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Feedback from Paul Eggleton suggested to not use the linked
term "Source Directory" in the last paragraph of this section.
Reasoning being that it is mis-leading in this case. People
reading this will be thinking more along the lines of traditional
source code rather than our establishe "Source Directory" term,
which in the doc set refers to either the unpacked poky tarball
or the cloned poky Git repository.
Reported-by: Paul Eggleton <paul.eggleton@intel.com>
(From yocto-docs rev: f9bfcdebf85481839df01442ee81c4c9e8ee559a)
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>
* Edits to get the patching the kernel section more sane.
* A tweak to the opening sentence of the compliance section to
rid it of the split-infinitives.
(From yocto-docs rev: 8e2ff293e85a602efd98aceb20da5a2ea5f2a34d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Made changes to try and clean up the process.
(From yocto-docs rev: 9c4fbcb473dc594647ba8779162379a745f8f8d6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Scott Rifenbark
Timo Mueller
Kevin Strasser
Robert P. J. Day
Robert Cochran