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_#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>
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>
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>
* 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>
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>
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>
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>
This section was out of date. I copied in the most recent version
of the bblayers.conf file, which sets LCONF_VERSION to "6" now.
Also, added the meta-yocto-bsp layer to the example.
Additionally, I inserted a Note explaining the consequences of
removing the meta-yocto layer. The note references [YOCTO_#3176]
for more information.
(From yocto-docs rev: 532b72c5c18b2a9a61619164bae6216c91c2ecc9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The current setting was changed from "1" to "6".
(From yocto-docs rev: 7f5be4b0b2d1e17add774c7ba3b8803ad770a8fc)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added the meta-yocto-bsp layer to the example listing in the
"Enabling Your Layer" section.
(From yocto-docs rev: 95fb13a1049ccaffb3531c93a28a3c480ea1a243)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I edited the patch from Paul a bit here to conform to
the style of writing plus to make things clearer.
(From yocto-docs rev: 87abf857cfcd8a0d78a48322fbe9ac5395b6ad30)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Better display of the SELECTED_OPTIMIZATION variable options
when they appear as a list.
Also, some punctuation added.
(From yocto-docs rev: 73777e545f13eacca9ee466ba852bccd84c17f6f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
'sdk', when used in general terms should be capitialized.
(From yocto-docs rev: 1d68746ae197620b533a9ad53e71b16c9e4e42b8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I found other changes for underlying/corresponding wordings
regarding the relationship between .bb and .bbappend filenames.
(From yocto-docs rev: 28f12a4ea97a683281cd8cc0bbceb40d2b896aa4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Better choice of word here is "corresponding" rather than
"underlying".
(From yocto-docs rev: 3d8b6d6e06b81960df2a7d25b6d54308210cc011)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The manual listed an out-dated example listing of meta-* layers
in poky.
(From yocto-docs rev: 39e2a02301d1d0b609fbc041395dd31f6ba9fa2d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the section "Using an External SCM." This section was
written so that PN was refering to a package instead of correctly
refering to the recipe.
(From yocto-docs rev: 2bf44cf78bef08d2dd4d9e596100900913777d60)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Task has been renamed to package group, and there are some minor changes
in how package group recipes should be constructed - in particular the
inherit of packagegroup.bbclass is now highly recommended as it will set
appropriate defaults and automatically add complementary -dev and -dbg
packages.
In addition to Paul's patch, I added a couple <filename>/</filename>
tags around some switch names to be consistent with manual
formatting.
(From yocto-docs rev: 598d18507ace2054f8c8bb5f496557c98f066b5a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a note in the "Creating Layers" section noting that to be
Yocto Project compliant, a layer must contain a README file. This
change was prompted by a discussion over the fact between Robert
P. J. Day and Mark Hatle.
(From yocto-docs rev: 2e073763a81125699a2d962031ca29ca64c81595)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated an old comment in the layers.conf file example to say we
have recipes-* directories instead of the old packages directory.
(From yocto-docs rev: c39394e848d6039e6728b7e53de86958f951e258)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Two areas of the manual updated to reflect the fact that not all
QEMU images have an SSH server in them.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: a173d8cb05ee695b02188a037ee047db016c6a67)
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>
Caught and fixed a stray reference to "appendix" that should be
"chapter."
(From yocto-docs rev: 97d26495dd9b561bb5724a86e9cd777eeef9f71a)
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>
Added the section "Using an External SCM" to the "Common Tasks"
chapter. This information was formerly in the YP Reference Manual
in the old development chapter.
(From yocto-docs rev: d34cd9e86cb7a6b27cf6a5b4daf58c445dd86331)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
It's CONFIG_SMP here, and since the title of the section already
mentions it, just change the sentence to be more generic.
(From yocto-docs rev: 32e6145b5f41d4eb293f8267ef01d02217143152)
Signed-off-by: Paul Eggleton <paul.eggleton@linux.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>
Scott Rifenbark
Paul Eggleton