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>
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>
Removed the temporary text in the new "Patching the Kernel" section
that was copied from the old appendix A. Fixed the PRINC variable
in the creating a new layer example.
(From yocto-docs rev: 3eba77a81d3460866638a2f2d6b7c27d9dd1a2be)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed the "kernel-example-repos-generic.png" file as it describes
the bare clone method for kernel modification. We are removing
that from this manual.
(From yocto-docs rev: c25c4f662c2f8a83fd9b09583646be9dbe01424c)
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 figure that shows the bare clone and the copy of the bare
clone are no longer needed. The description for the kernel
workflow has been reduced to discussing only modification of
the temporary source files. We are no longer talking about
creating a bare clone and copying it as a way to modify the
kernel in this manual. That topic will be described elsewhere.
(From yocto-docs rev: f6a25e5e3763ea7a1f8a81ce377e3b520143b852)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The "Common Tasks" chapter is better suited as the last chapter in
this manual. So I moved the development workflows up a chapter.
(From yocto-docs rev: 19f0a6411c065388b5bd0083338b164b43baff0e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The kernel example appendix is now gone.
(From yocto-docs rev: d744e76034ff2711a8c40b9bb1982971d28a04b1)
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>
Eliminated the section A.2, which had an example of how to use
menuconfig in the kerenl example appendix. The information is
now merged into the similar section in Chapter 4 "Common
Tasks." It was decided that the Appendix A examples in the
manual were too detailed for a general development guide.
(From yocto-docs rev: f88ec421b257657f02cc0f132ec2580c17f07cef)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
this statement in the linux-yocto-3.4.bbappend file needs to
have the comment removed so the source can be found.
(From yocto-docs rev: 821162221818f5ce53bb903aeef57c85314f5083)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the Kernel example appendix I changed some remaining 3.2
kernel strings to 3.4. Also I added the OE_INIT_FILE variable
from poky.ent for use instead of the "oe-init-build-env" string.
(From yocto-docs rev: 1d9d8d72d197bdd81756eed7fe1529f341de6089)
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>
Scott Rifenbark
Kevin Strasser
Robert P. J. Day
Robert Cochran
Paul Eggleton