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>
Minor edits to the part of the example that sets up for the
first core-image-minimal build. Put in the variable to use
for the build environment setup script, updated some changed
output from some of the commands, etc.
(From yocto-docs rev: 0b4b2ddf9a78a9d6d218ed9a6f0acd3e876d9581)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Danny, the "kernel-example-repo-<release>.png" file changed to
"kernel-example-repo-danny.png". To correctly make the dev-manual
and the mega-manual some things needed to change:
1. New figure created and added to both the dev-manual and the
mega-manuals figures directory.
2. The "kernel-example-repo-denzil.png" files from the dev-manual
and mega-manual figures directory was removed.
3. The Makefile was adjusted so a new BRANCH=danny area now exists
to set TARFILES for both dev-manual and mega-manual.
(From yocto-docs rev: 8b2ff6b657a1486559799e219baaec9fde2e5c6c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added a note at the beginning of this appendix that references
the yocto-kernel script as a way to quickly manage kernel patches
and configuration.
(From yocto-docs rev: 35cd7f6a9722120e47ae8b422dd86593497ebf1c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This appendix is antiquated and needed removed. The BSP
development example is now in the BSP guide where it talks
about running the yocto-bsp script.
(From yocto-docs rev: 892ff450d79a7564a72f11eb7510d349ca71d47a)
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 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>
The examples were out of date. They did not show the
meta-yocto-bsp layer, which is there now by default.
(From yocto-docs rev: ea2e2e8a259bc3e629fb8087229872b9818a696a)
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>
* Explain that we test with a set of reference hardware rather than only
supporting hardware that we have (avoiding any implication that the
build system can't support other devices). These are in the
faq entry in the poky-ref-manual for the question of how we can
claim Poky / OpenEmbedded-Core is stable.
* Adjust the language so that it is OE-Core friendly, with a link to
the Development Manual for the definition of OE-Core.
(From yocto-docs rev: 5ff1604dd383b26e918c319fcbe46dd1589cebc5)
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>
I updated the listing of the final SRCREV statements for the
BSP example.
(From yocto-docs rev: 0d0d5994c2653dda1171eaad226bbe1764a04440)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These changes are partial for converting the example for BSP
creation from Crown Bay to Fish River Island 2.
(From yocto-docs rev: c7fc78a8453ad363138764aa30e377b56ce49f2b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed the reference to the Downloads page.
Also fixed the local branch in the meta-intel example so that
it uses the same name as the local branch created for cloning
poky.
(From yocto-docs rev: edac781b37bce0d0bca6a741186cfa53a512b73e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The new branch is named distro plus poky revision
(e.g. danny-8.0). I had just the distro in there.
(From yocto-docs rev: 9490849f7f6dc815d1b676b15b3f38f671a49be8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The term "Source Directory" should be capitalized.
(From yocto-docs rev: 143213545358dd5b6c28c71202bea2e40dbb2522)
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>
Added information in the #4 box to include the cross-dev
toolchain.
(From yocto-docs rev: 198ab4326369d8c74225d9de51bf536621ab2251)
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>
I made this more accurate by including notes to edit the
source and use of menuconfig within the diagram.
(From yocto-docs rev: 91d3d2e935aab24c4bd96c5921a605cbbb7e3231)
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>
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>
The description for where the "scripts" directory lives was not
conforming to our terminology.
(From yocto-docs rev: 925167c446b86ca09d387d01568db64113412311)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
For obvious reasons I changed this one :)
(From yocto-docs rev: 5f3203292f46bea799321e4520668252a46fb599)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I improved the wording such that it is not tied to a
x.x type release. It is more generic here and will survive
better under future releases.
(From yocto-docs rev: 2bd644db7fef71cd2f07f6d3dcbd2ba60b83df08)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a line to cd to the poky directory so the example makes
sure the meta-intel directory is created in poky as it states.
(From yocto-docs rev: fdeff0fc2c61c521eaf9d3c48429792f1559c2a4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated so that the repo poky-extras is for sure created inside
the poky repository.
(From yocto-docs rev: b01ea76ded2ade66f2cb19b37d9e9d8d5d2e96c9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
changed the example of what the manual does not provide to
be more appropriate.
(From yocto-docs rev: c4e7712cfd2e13b42f7322ffed6a1f84116df963)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Section A.5.2.3 "Changing recipes-kernel" indicated that the user
needed to look in poky/meta-yocto/recipes-kernel/linux to find
the linux-yocto_3.2.bbappend file to locate correct SRCREV
values. With 3.1, the team split out kernel and BSP stuff
even further by creating a poky/meta-yocto-bsp directory.
The example needs to reference that directory instead.
(From yocto-docs rev: 6e9b0ceb5ad24b1be8399bf5a0a83fdc30129f82)
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>
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>
I fixed the repo example so that the -b option is right after the
git checkout command and so that the "origin/" string is part of the
example.
(From yocto-docs rev: ba7ed26cf308a69e1ec8cfb0072dd10742af4ac5)
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>
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>
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>
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>
I updated the section that describes how to submit a patch through
email while not using the scripts that send patches and request
pulls.
(From yocto-docs rev: 9167b89289134d8d16610cc527d0d71713c0641b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed the title and a single reference from the Kernel manual
to a title more representative of how these patches are sent -
not using scripts.
(From yocto-docs rev: ff908c34fae88eab9724891a008142a834f34081)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added text to indicate that using the two scripts for generating
patches and requesting pulls is the preferred method to send
a patch.
(From yocto-docs rev: d6f036a91074dd00c51fe0f937224182fc801b3b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed the section heading for the part describing how to
push changes upstream via the poky scripts. Also had to
change one cross-reference to the section in the kernel
manual.
(From yocto-docs rev: be7712aba044238e8781cdf869c5d14e77eb09a2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Every place in the YP documentation suggests setting BB_NUMBER_THREADS
and PARALLEL_MAKE to twice the number of cores as the host machine.
This fixes a single instance in the YP dev manual where it was
suggested that PARELLEL_MAKE be set at 1.5x times the number of
cores.
(From yocto-docs rev: b6b820371cbe43e39425156c72c45df283fdf7d1)
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 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>
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>
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 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>
I moved "the" outside of the generated HTML link so that the sed
script will process this part of the manual correctly for the
HTML mega-manual.
(From yocto-docs rev: 3bdf7c7dc4478f2a435cbc84a8a815daf7130660)
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>
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>
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>
Changed the first sentence of the description of how to use QEMU images
with NFS server. This is feedback from Scott Garman's review.
(From yocto-docs rev: 6a33b1b58bd72756baf57228b7348ff662248012)
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>
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>
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>
The name of the ADT manual has changed to the "Yocto Project
Application Developer's Guide." This change had some ripple effect
regarding cross-references into the manual. These are now fixed.
(From yocto-docs rev: 7ba25c470b03a85098388e6cca7c78a6ebb245d8)
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>
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>
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-varibales-gloss" appendix to a chapter and
made sure any references in the doc set use the proper term now
(chapter).
(From yocto-docs rev: 3f541c20c7aff1012eb4c06cb856bf9795124822)
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>
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>
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>
Fixes [YOCTO_#2671]
Added a bit more in here about considering requesting rights to have
a contrib area to YP and OE if user is a regular and significant
contributor.
(From yocto-docs rev: b54bba33b2706bed593a9ee66d5c72f820c37d32)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section that describes how to send a patch upstream via email
did not have a good connection to the various mailing lists. I
added some references to this section and also mentioned using
the scripts if the user has many changes to commit.
(From yocto-docs rev: ad75ae45420c43bda974d22b02094237b5c7cc50)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Bug 2256 is now fixed in master and the fix will be in the next release,
so update the documentation accordingly.
(From yocto-docs rev: 877a7ecfd1623417d0793a5dd16b66c35b6fdbae)
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
"shared state cache" is the generally accepted term for this.
(From yocto-docs rev: a15f629afe46e7217182a1ac077ab59641be9a8c)
Signed-off-by: Paul Eggleton <paul.eggleton@linux.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>
* Change some of the language and patch submission directions to
correctly represent how we work together with OpenEmbedded (this
changed with the introduction of OE-Core a few releases ago).
* Correct --help option to -h for pull request scripts
* Clarify commit message guidelines
* Touch up a few other bits and pieces
Fixes [YOCTO #2671].
(From yocto-docs rev: 3170ce5e0757951afee13207c117316e33449b39)
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>
Scrubbed the manual for the term "Yocto Project", which has been
over-used. I updated occurrances to better represent actual bits
rather than generically referring to everything as Yocto Project.
(From yocto-docs rev: f70cffeffa0d8863a88783607621bf6f7125d02d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The example did not specify to switch to the "denzil" branch after
establishing the local repo of poky-extras. The example will not
work without this step.
(From yocto-docs rev: 90071570bca2edfceb4adb91bdd9093c095c8825)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Previous renditions of the term "Build Appliance" referred to the
VMware system. However, it was determined that the term
"Build Appliance" should really refer to the actual image that
can be booted and run on the VMware applications. I have updated
the areas affected by this change. The change assumes the name of
the built or downloaded file you boot will be named
"build-appliance-image."
Fixes [YOCTO_#2656]
(From yocto-docs rev: 6b27b7d92b9722351eb43a7c2a341ce3af056dba)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some minor typoes in first couple chapters
(From yocto-docs rev: 36618cc6a261a994b00c5c524c76cbf3952a2eae)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Moved the sections on remote debugging and using the profile out of
the YP Reference Manual and into the YP Development Manual. These are
now two sections in the "Common Tasks" chapter.
(From yocto-docs rev: 42640bf69aa05c56eb112c10b6d7b96069173785)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Paul Eggleton
Scott Rifenbark
Ross Burton
Robert P. J. Day