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>
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 #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>
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>
* 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>
* 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>
Made some general edits to the new "Patching the Kernel" section.
Also had to remove a couple of images no longer used in the section
from the Makefile "TARFILES" variable.
(From yocto-docs rev: ac61e22e2f89926fbbda56fbaa4384c3c5156360)
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>
Each time the kernel revision is bumped (e.g. 3.2 to 3.4)
Some of the figures would be out of date. The reason is they
had pathnames that included the release of the kernel.
For previous YP releases I was adding logic to the Makefile
to be sure to catch the right files dependent on the branch
from which the documents were being built. This scheme is
not scalable so I decided to make the figures generic by
adding a note within the figures explaining the place-holder
"<x.x>" as part of a pathname. Thus, three new figures were
added to the folders directories of the dev-manual and the
mega-manual. Correspondingly, the 'denzil' version of the
figures were deleted.
I modified the Makefile so that if the BRANCH is not edison
or denzil then the generic figure set is used. I have to retain
the logic for both edison and denzil to cover the case where
a user clones or sets up an edison or denzil repo and then
builds out the manuals. Basically, it had to be backwards
compatible for releases prior to danny.
(From yocto-docs rev: 8283eed4b0b9ec164b87db99c35231f8731ac443)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This section now points into the BSP Guide where it talks
about using the yocto-bsp script to create a BSP. The prior
method was by hand and described in an appendix (A) of the
YP Development Manual.
FYI - this results in the removal of Appendex A in a future
commit.
(From yocto-docs rev: 5e1c44b1768b79dd1447ea47461b84248bd2111f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the Quilt and Git flow methods there is a bullet that talks
about incrementing the PR variable. I changed the wording to
be in the context of recipes rather than packages.
(From yocto-docs rev: 64f6230251c023e469a346c0425834b950ed5c9b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The example that describes changing the source code usees the
P* variables extensively to refer to names of the recipes. The
wording used was antiquated and exclusively referred to
"Packages." I changed to reflect the fact that P* variables
in general are refering the recipes and not the packages.
(From yocto-docs rev: bd3ef1c46fc7a3b0b2ff5ab60dc52e125f080e24)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
some of the links to information for the user-space tools
had become obsolete. Fixed them.
(From yocto-docs rev: 84e72204e34e45d9d8cae876710a46a83b61c0cc)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I changed the preferred branch for the Eclipse example from
a hard-coded "1.3_beta" to use the DISTRO_NAME variable.
(From yocto-docs rev: 9393c5d1e44a1e326c73353b090c1d1c1a5833da)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the item that talks about getting the root filesystem.
Realized that the cross-toolchain was not discussed in this
bullet for the case where a user does not use the ADT
Installer. Added text and references to correct that.
(From yocto-docs rev: ec2f5103471f047f7ed7e53cc22789c74ab506ae)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added an earlier occurence of the "tm" for Eclipse product.
Also, changed the reference for modifying the kernel to point
into the appendex rather than self-referencing the same section
from where the reference originated.
(From yocto-docs rev: a85840611650c9124b6194acca59c8bfe71f566c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I standardized the use of the term "Source Directory" when
referring to the poky directory as set up on the host.
(From yocto-docs rev: 3eaf7a734a4eecab2be2c8e71bee4d6c2cb7788b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Needed to add the 3.4 kernel to the list of linux-yocto-*
kernels as found in the source repository.
(From yocto-docs rev: 98538e2616214f76083697ad3cc886efd183c34e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The bulleted item that describes where to look for application
development was still pointing exclusively to the adt-manual.
Updated to point to adt-manual for host setup only and then
point to section in the dev-manual for the Eclipse example.
(From yocto-docs rev: 36ac631e23366c4d9f83c2d00cbbd3bc4758aa15)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
For 1.3 there is not longer a toolchain tarball. Instead, there
is a wrapper script that lets you install the tarball. This
fundamental usage model change caused several ripples throughout
the documentation set. I have changed wordings and examples
to reflect the new paradigm.
(From yocto-docs rev: afb2069daa91e04c0f78ba425a6b184cb820d888)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The steps for creating a project in Eclipse vary a bit between Juno
and Indigo. These changes reflect that.
(From yocto-docs rev: a020ecde8ed02a29f67498ef1511261d2054f784)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Edits to test out the lastes version of installing the Yocto Eclipse
plug-in from the latest source. Small changes to be more complete
on the step-by-step process with regard to being in the right
branch. Also, inserted 1.3_beta as the version. This will change
later.
(From yocto-docs rev: 1326916a7d03bdbb0613e6e26a4089b3bd87d204)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Robert P. J. Day pointed out a link in the development manual that
was for the BitBake User Manual. The link resolved to an old,
non-maintained version of BitBake documentation. According to
Richard Purdie, the BitBake docs referenced should be the ones
that ship in the bitbake/doc/manual directory of poky. The
YP docs had been using a variable named BITBAKE_DOCS_URL that
also resolved to the antiquated user manual site. Consequently,
there were many links that needed fixed across both the YP
Development Manual and the YP Reference Manual. Each of these
references now points in general to the bitbake/doc/manual
directory in poky for more information.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 12f77236b602e9ec43e845c8cec060ad342af19c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I fixed a reference to a manual that should have had "Guide" and
not "Manual"
(From yocto-docs rev: a51de96fe0cd78cb379e6758d7e357c91daa2791)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed several references to books. There should be no books referenced
using "The" at the beginning of the manual title. These need to be
"the" in order for correct mega-manual link processing with the
sed script.
(From yocto-docs rev: 76753216c7138d55f7b6f9167d678245ab3134e7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The way I refered to the YP Quick Start was inconsistant.
I have made edits to remove these.
(From yocto-docs rev: d9487c60db23861e8a9dd2c81ac46d4960abd462)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2929]
Provided an updated section on how to install and configure the
Eclipse IDE so that it supports both Juno 4.2 and Indigo 3.7.2.
The fix included creating a new poky.ent variable that is
Juno-specific.
(From yocto-docs rev: 6b0b046322420f56feb644eb6de8341dfac59df2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The detailed chapter that describes how to install and configure
the Eclipse Yocto Plug-in has been moved to become a subsection of
the "Workflow" chapter in the YP Development Manual. This commit
accomplished the bulk move, edits to integrate the information,
and fixes to all cross-references. Moving the chapter creates a
sectioning issue in the YP Development manual that results in
subsections that are six levels deep. Not ideal. Will look at
fixing these with a subsequent commit.
(From yocto-docs rev: e6abff8f578f2cf6997895260f607395281ae8e8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In preparation for taking the Eclipse installation and configuration steps,
I have made an edit pass through the section "Workflow Using the
ADT and Eclipse". Minor edits performed to integrate the new
information.
(From yocto-docs rev: 7b4e0ae371b23f329451ac768b7d9eab5931df2d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
As part of moving the reference manual to a real reference manual I
am removing the "appendix" classification and having everthing be
a chapter. I changed the "ref-imagese" and "ref-features" appendices
to chapters and made any references in the doc set use the proper
term now (chapter).
(From yocto-docs rev: 08117634034a5cd5567c971957583d986c9ee9a4)
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: ddee80872afc567b9381387980f257b337f29ea1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I inserted the section "Using a Development Shell" into the "Common
Development Models" chapter. This information was formerly in the
YP Reference Manual and is being moved out to help the ref manual
become a truer reference manual.
(From yocto-docs rev: f4ca1c567afcebbae119f21c147e3c38c7ffd54e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Throughout the manual, the kernels that are built and available through
the Yocto Project were being referenced as a "Linux Yocto kernel."
This reference is poor. First, it placed Linux and Yocto very close
together and could upset the Linux folks. Second, a better way would
have been to say "Yocto Linux kernel." I have fixed by referring to
kernels that are available through the Yocto Project as
"Yocto Project kernels."
(From yocto-docs rev: 9b8319328cd4ab4ce3363001c9feeec585d9cab9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I have replaced the term "Yocto Project" with more appropriate terms
where possible.
(From yocto-docs rev: 622ef9a2b4897ecd151b641b43d7706ab673c989)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section "Modifying Temporary Source Code" that was in the chapter
for "Common Tasks" was moved to the "Common Development Models" chapter.
After discussion with Darren Hart, modifying temporary source code
is a valid develop model. So, rather than isolate it in the common
tasks chapter it has been placed in the development model chapter,
which now has four types of development.
Changes were made to update the introductory text of all the concerned
areas of the manual.
(From yocto-docs rev: 8b07ee3bcda9c13e576b54b0079b0656cd8fcc32)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Scott Rifenbark