Applied review edits to adjust this section for the
extensible SDK stuff.
(From yocto-docs rev: d386fca0b4e54ae2d5e610b37089fb058d80a746)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added some new files to the list of files highlighted for this
directory with "sdk".
(From yocto-docs rev: 213371bc5c5eb00d37ace5f2b330a87e1f10b73e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This was a complete re-write of the YP Quick Start in an attempt
to streamline it, remove unecessary detail, and make it flow better
with the examples. In doing so, many manuals were affected due to
section headings being renamed, information being moved, etc. Here
is a list of the changes by manual:
Makefile - Removed two figures from TARFILE list for the
yocto-project-qs.
Added building-an-image.png to the ref-manual TARFILE list.
Added using-a-pre-build-image.png to the adt-manual TARFILE
list.
Repositioned 'eclipse' in the adt-manual TARFILE list.
adt-manual: Fixed a cross-reference so that it goes to the new
'Building Images' section that is within the YP QS.
Added new section 'Example Using Pre-Build Binaries and
QEMU' to hold the information that was formerly in YP QS.
dev-manual: Removed a cross-reference into the YP QS that promised how
to configure the most efficent build.
Changed a cross-reference into the YP QS from 'The Packages'
to 'The Build System Packages'.
Changed a cross-reference into the YP QS from 'Building an
Image' to 'Building Images'.
Changed a text reference from the YP QS to the adt-manual.
Moved the bit about getting YP files by using the YP website
from the YP QS to the dev-manual.
Changed a cross-reference into the YP QS from 'Using Pre-Built
Binaries and QEMU' to 'Example Using Pre-built Binaries and
QEMU', which was moved to the adt-manual.
ref-manual: Changed a cross-reference into the YP QS from 'What You
Need and How You Get It' to 'Setting Up to Use the Yocto Project'.
Moved the note about if your system has oss4-dev in the
packages area in the YP QS to the appropriate area in the
ref-manual.
Moved the introduction information regarding building an image
along with the figure from YP QS to the ref-manual's section on
building images.
toaster-manual: Changed a cross-reference into the YP QS from 'What You
Need and How You Get It' to 'Setting Up to Use the Yocto
Project'.
yocto-project-qs: Complete rewrite that changed many section headings and
removed much detail, which was placed in other manuals.
(From yocto-docs rev: da4ed8147b04963a700caa784bda709c57b4eb6e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I applied a little more information to this section to help
round out the variable explanations. Part of the change involved
adding PARALLEL_MAKEINST to the list of scaled variables.
I had left that variable off. Also added a new trade-off.
(From yocto-docs rev: 3d85d5385c03841c17dd33afb94c110edc12170f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed the references to eglibc and replaced them with glibc.
This involved updating the example buildhistory output with
current examples as well
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: b44cce9817191d616d51d6b1d067efc730423198)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The "Speeding Up the Build" section presents a list of items the
user can consider when they want to tweak the build speed. One of
the items is the three variables BB_NUMBER_THREADS, BB_NUMBER_PARSE_THREADS,
and PARALLEL_MAKE. It was noted that the system figures out
the optimal settings for these now and it is pretty useless to
override the settings. However, the introducing sentence to the
list is still valid due to other considerations that go beyond these
three variables. So, to update the text, I have re-emphasized the
role of these three variables for quickening the build time.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 84610550cef66d0aa7478bcf95ad97b081709b2f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Throughout the manual I had been using angled bracket sets to
denote user-supplied input. This is confusing and better shown
by using the <replaceable></replaceable> tags. I scrubbed all
the chapters and replaced as needed.
Some other minor formatting changes were caught and fixed during
the scrub as well.
(From yocto-docs rev: 9a668574dd18828a750cfa2e8c28e1f089a19609)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied the full set of first draft revision edits for the
new migration section for 1.7. Comments from Paul Eggleton.
(From yocto-docs rev: 90586addbc719ecaf7c768b267adf0e988e27b74)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This file is what is written now rather than build-id. I changed
the file name and noted that it also contains the full build
header information as written out by BitBake during the build.
(From yocto-docs rev: 7e55b4b5f9e27f6ac5d8f1eab4923bf1b8a712c6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Replaced with packagegroup names, the newer form.
(From yocto-docs rev: 5492b0669acc9ce8a8ee1a00dfdc7e9f2b98a5c4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I found an occurrence where we were refering to the removed
task do_package_write. I changed it to "do_package_write_*"
(From yocto-docs rev: 4e989f2df1cf74c81ba9d02088addb79012762a7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #6499]
Updated three areas to include similarly licenced components
regarding the use of non-GPLv3 licensing.
(From yocto-docs rev: 88c0720e4070be58fbde17bc04db2b53c3307bf8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There was inconsistency on how we refer to a task name throughout
the YP manual set. The proper way is "do_<taskname>". Some
occurrences did not include the "do_" prefix. These have been
fixed.
(From yocto-docs rev: b32821bb0d3e6de7bca68b25c662a023526a10c4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
With the creation of the new chapter that documents the 51
tasks defined by the OpenEmbedded build system, the remainder
of the ref-manual had many first-instance occurrences of do_*
task names that could be cross-referenced to the new sections.
I have added these links.
(From yocto-docs rev: 2ff39bd226a1d8f11924283bbaa3542a9d936ba3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Along with some minor things I did the following:
* Added a brief explanation and reference to the reporting error
tool. It seemed like a good chapter to include it. I put it
in the debugging section.
* I added a pointer to the BitBake manual right at the top of a
section that had many usages of the bitbake command.
(From yocto-docs rev: 9317433bc715e9fdac2fc629ed659ac926d67531)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Paul Eggleton noted that the output to bitbake <target> -c listtasks
was documented as going to a specific file only when in fact it
also goes to the console. I updated the section to include that
fact.
(From yocto-docs rev: 0ed7da3f0fc21412c1045889f241a3d86587d16f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The opening sentence here said that the build history is
kept in the $TMPDIR/buildhistory directory in the Build Directory
as defined by the BUILDHISTORY_DIR variable. Well, the variable
claims it is kept in $TOPDIR/buildhistory. I went with the
variable as the correct source. So, I changed the intro
sentence here.
Reported-by: Laszlo Papp <lpapp@kde.org>
(From yocto-docs rev: 242e372affe771776bdfc17f3e3f5187d8965467)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed the bit about isolating SDK information. Also removed
the workaround and text regarding the limitation that caused
adding and removing INHERIT += "buildhistory" to re-execute tasks.
Added a few links to some newly documented variables.
(From yocto-docs rev: 7d13bea6d9f0c2bdc9aa58c2933998d6d10ac810)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I modified a few areas to help integrate some newly documented
BUILDHISTORY_* variables. Mostly some rewriting to feature
some variables that help the user select build history features.
(From yocto-docs rev: 8cb6a09ba7f0bd645a12e6f7a93247a9f0e77980)
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: bd9f4ab6bd54a6d0edff1f5cfb6ea4d46f5bc9f1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the "Dependency Graphs" section, the pn-buildlist file was
not mentioned as a file generated by the
'bitbake -g <target>' command. I added this in and provided a
bit of re-writing.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 435de6a980bd182e8033319e479ded1414e93eed)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This term should always reference a users current working directory
and not be confused with the OpenEmbedded build system's "work
directory (WORKDIR). I found several instances where the term
"working directory" was not used correctly and fixed them.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 300c78c1d54b2a4fbb8ecca03faa7c8c67bdc54f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There was inconsistent use of the way directory names were
handled throughout the YP documentation. I have scrubbed the
set and replaced many instances such as the following:
meta/<something> replaces /meta/<something>
poky replaces ~/poky (except in some very specific examples)
I basically got rid of leading slash characters.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: ae2e451ed8f61484d04b30017021912c4493a441)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There was some confusion over some things in these two sections.
I re-wrote them with the help of Paul Eggleton to be clear on
them.
Reported-by: Robert P. J. Day (rpjday@crashcourse.ca>
(From yocto-docs rev: ab352523e82626d8356d8b2c07fb10d2d60ea254)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Patch from Robert P. J. Day. Good catches for some minor
wordings and such.
(From yocto-docs rev: 44c98e879bddfee49a5b89e7bb9c94c403284140)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5303]
Added a bullet item to the files listed as part of images
in the buildhistory figure.
(From yocto-docs rev: 5c4c581cde509b880b0d36dad399df0cb510b2d2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The main changes are captured in a new section devoted to the
oe-init-build-env-memres script within the ref-structure.xml
file and in the variables.xml file in a BBSERVER variable entry
in the glossary.
All other changes were necessary to integrate the new functionality
into areas where running the setup script are discussed. Before
this feature, there was a single setup script (oe-init-build-env).
Consequently, wordings and such were designed exclusively for this
single method. With the introduction of a second possible method
to initialize the build environment, tweaks to many sections were
needed. Beside the wording tweaks, appropriate cross-referencing
was also needed.
All these changes cover the integration of the new feature.
Reported-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: c55c9a53c9b4cd1e06e6e81e32d56f9bbf5fe98c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The URL naming convention for the YP Release Notes has changed.
It now takes the following form:
http://www.yoctoproject.org/download/yoctoproject-15-poky-1000
The above is an example for YP Release 1.5 and poky release 10.0.0.
I have set up three new variables in the poky.ent file to somewhat
automate the links in the docs to point to the location of a given
set of release notes:
1. DISTRO_COMPRESSED - set to the DISTRO string with no period
(e.g 15 for 1.5).
2. POKYVERSION_COMPRESSED - set to the poky version with no
periods (e.g. 1000 for 10.0.0).
3. YOCTO_RELEASE_NOTES - set to the full-blown release note
URL.
I made two changes to existing links for the Release Notes. One
was in the dev-manual and one was in the ref-manual.
(From yocto-docs rev: e6088927980a1de8022b22f7f38b3046fea20235)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied some re-wordings as suggested by Bill Traynor.
Reported-by: William M.A. Traynor <wmat@alphatroop.com>
(From yocto-docs rev: 2510d9795720afc0309a10b18605e5af4a83769b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add a paragraph to the top of the section on buildhistory mentioning the
metadata-revs file and the top-level directories.
(From yocto-docs rev: ae7c7c64dd31f5b5c57eac9c772972523f49c05a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Did some rewriting to conform to the manual's style and
formatting.
(From yocto-docs rev: 6a961978b207d8992ade86f82838914b858accdb)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Additional information added to the end of the
"Build History Package Information" section."
Buildhistory now collects information on SRCREV values for recipes
fetched from a version control system e.g. Git; additionally a
buildhistory-collect-srcrevs tool is provided to gather this and
convert it to a format suitable for inclusion in global configuration.
Add information on these new features to the appropriate section.
(From yocto-docs rev: 8c38bcbe8e737d7dfb41a763c87a3a6269e6f980)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I did a bit of cleanup on the text from Paul's patch number 1.
Just some active voice stuff mainly.
(From yocto-docs rev: f08fa3da997e53c587e3f17ef908e41594654db3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New section titled "Build History SDK Information" added.
(From yocto-docs rev: aaa9ee5690a68f72b21ca3ab731942d80acac2f3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
this was really old text and had not been touched since the
original poky handbook days. It was terrible.
(From yocto-docs rev: 4f3efdbf2920f7d3f2d0d0526d08340c6204856a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a couple cross-references for some general debugging
information within the manual set.
(From yocto-docs rev: d102e90fc9b24aa703eeb4488561058c258600d6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes YOCTO #2790
Created a new section in the "Debugging Build Failures"
section to deal with host issues that cause a build to
fail.
(From yocto-docs rev: 9efc00146764086646b0c558d12168ab9813d683)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Scott Rifenbark
Scott Rifenbark
Robert P. J. Day
Paul Eggleton