Also, fixed a link that was going to the sdk-manual. It needed to
have the target removed.
(From yocto-docs rev: 1aec95f6b2615a1153c6bbbca7f04739bb7fe76c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The BB_SETSCENE_VERIFY_FUNCTION2 variable no longer exists. I removed
a link to the BB manual to this variable description, which no
longer exists. Also, removed a paragraph in the discussion around
setscene that talked about the variable.
(From yocto-docs rev: 1f8e3d53ee72c369cb1211332e074976737fd76b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changes covered several areas. Version 2.3 of the YP now supports
recipe-specific sysroots and is not limited to machine-specific
as was prior releases. Manual changes were as follows:
dev-manual: "Sharing Files Between Recipes" - Wordings were changed
to support the new functionality.
ref-manual: do_prepare_recipe_sysroot task added to the list of
tasks described in "Configuration and Compilation".
ref-manual: Extensive re-write of the "staging.bbclass" section.
ref-manual: Added a section to the build structure for
build/tmp/work/tunearch/recipename/version/. This section breaks
down the recipe-specific subdirectories used to create (stage)
the sysroot.
ref-manual: New section (entry) for the do_prepare_recipe_sysroot
task in the task chapter.
ref-manual: Added a variable glossary description for the
SSTATE_SCAN_FILES variable.
In addition to these changes, I sprinkled in a liberal amount
of cross-referencing for the readers pleasure.
(From yocto-docs rev: 3a8ca96861f4c5d3badb91d0cdc5a3df513d4e59)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9675]
Various fixes to replace the "smart" package manager references
with "dnf".
(From yocto-docs rev: 721dc7fb637c4c03534eb19f61b0b08a7303826d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The BB_SETSCENE_VERIFY_FUNCTION variable has effectively changed
names to be BB_SETSCENE_VERIFY_FUNCTION2. I made the one instance
of it correct here.
(From yocto-docs rev: c2864dace370d7a43234f4728b33f25082e628e3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Put a closing reference in the "Stamp Files and the Rerunning of Tasks"
section to point the user to the area that tells them how to
view information about a task's signature.
(From yocto-docs rev: 3f395ef1999a2aff1447da4d257fd5d53124aaa7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a new variable description for SDK_INCLUDE_TOOLCHAIN.
Along with the new glossary entry, I updated a couple places
where it would be relevant to cross-reference the new variable.
(From yocto-docs rev: df99b097595e7488a93354082b8d9f33acd9c229)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10183]
Added a new variable entry for the PACKAGECONFIG_CONFARGS variable.
With the introduction of the new PACKAGECONFIG_CONFARGS variable,
many places in the mainstream YP documentation that referenced
how to pass configure arguments using EXTRA_OECONF needed to also
make mention of this new variable. I added many cross-references
to the new variable.
(From yocto-docs rev: 00f02d45319bab90b72eab89fcb69cbe8bd05bb5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10172]
I added a new section on how BitBake reruns tasks based on the
stamps files. Also put in some cross-referencing links to that
new section in the stamps entry for the structure chapter and in
the STAMP variable in the glossary.
(From yocto-docs rev: da8779d9eb85473cd6b0f74e9e1371e1d277890f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9251]
I added a new section on the task variants for setscene, which uses
the shared state cache. The section describes the BitBake processing
that helps the build system to not have to build everything from scratch.
(From yocto-docs rev: 6aa0e6b837de14dd7d6c5ef34328bbf268dd6d71)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Occurrences in many manuals and one figure.
(From yocto-docs rev: 26d30cd162083c62216fb4ab526d0b231f453de1)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed the heading for "Optionally Building a Toolchain
Installer" to "Building an SDK Installer". This changes the
heading and many references to that heading.
(From yocto-docs rev: 97d8cd34d0dd0993b1b1135bb75f2212bb46878a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied review comments to the section.
(From yocto-docs rev: 83871d0f6cd996be2d3476bdfc0f2adef9ff52a7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the figure for this section to include some stuff
for the extensible SDK. I updated the text supporting the
figure to cover the different SDKs and the different SDK
variable sets.
(From yocto-docs rev: 5aafab3e2e841293ddba45dfd8683cbdc223ed7c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the figure used to show SDK generation. I added a block
to cover the extensible SDK stuff. This affected the figures
folder in both the ref-manual and the mega-manual.
Updated the text section to support the new figure.
(From yocto-docs rev: b9fd7c2b0ea0e2fe1805a1bb1eb1bcb82c807b66)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I included a new paragraph at the end of the section describing
configuration in the "Closer Look" chapter. Cases exist when
two configuration files set the same variable. Depending on the
order, the last configuration file parsed is the one that actually
sets the variable.
Fixes [YOCTO #8914]
(From yocto-docs rev: 260e7dea7879846bcd3f3475cef001e512c657f0)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added the SDKPATH variable to figure. It was missing.
Also, had to adjust the display parameters to get it to
display decently.
(From yocto-docs rev: 4862288ab4675051ec6fc93927839da7eb3634b6)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Rewrite of devtool reference section. This was a separate commit
but got squashed wrong so it ended up with this commit.
The changes to "Image Generation" section reflect the new, more
detailed image generation figure
(From yocto-docs rev: 827c6872b88c17d2d0c8d44b1024fff19076e505)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #8941]
Confusing wording existed surrounding how the auto.conf file
needs to be created. Early in the section indicates that you
must hand create the file. Then later, it indicates to not
hand-create it. In reality, this file is not auto-created by
any script but is really usually created by an autobuilder.
I updated the verbiage to better explain this.
(From yocto-docs rev: 2dd8f60251009038d6bc61e2257876baebe8e0be)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #8298]
Updated several classes with feedback from Jose Lamego of Intel.
The feedback fixed some class groupings so that previously isolated
classes could be bundled under common classes (e.g.
autotools*.bbclass).
I scrubbed the cross-references for cases where a particular
class became "undocumented." The cross-references now point to
the bundled class entry in the ref-manual.
(From yocto-docs rev: 07a533cb41ad26d202f4e303f2dbc7d7bf26e076)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In response to community input where developers were attempting to
locate information on how to write packages out to a directory
other than ${DEPLOY_DIR}/<package_type>, I updated the "Package
Feeds" section, added several new DEPLOY_DIR_* variables, updated
four classes, and updated four tasks. Here are some details:
* Made changes to the "Package Feeds" section to provide more
accurate information in the package feeds directory structure
used by the build system in build/tmp. These changes included
updating the figure itself and some explanatory text.
* Updated the DEPLOY_DIR variable description.
* Added new variable descriptions for DEPLOY_DIR_DEB, DEPLOY_DIR_IPK,
DEPLOY_DIR_RPM, and DEPLOY_DIR_TAR.
* Updated the related classes: package_deb, package_ipk, package_rpm,
and package_tar.
* Updated the related tasks: do_package_write_deb, do_package_write_ipk,
do_package_write_rpm, and do_package_write_tar.
Reported-by: Trieu Nguyen <trieu.t.nguyen@intel.com>
(From yocto-docs rev: e8742267506bf9359346cfcd3965f762ed2c7d6f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The way the old manual set had worded the use of the
BB_NUMBER_THREADS, PARALLEL_MAKE, and BB_NUMBER_PARSE_THREADS
had become depricated. It suggested a lot of user intervention
to get these variables set to have the build system utilize
optimal parallelism. The change a while back to the build system
where the variables are set to the number of build host cores
now makes the variables automatically be set to their best
values. I have gone through the manual set and changed wordings
appropriately to reflect this.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 3a27b1792c92a2f22173315e2732f672cdad2c78)
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>
Fixes [YOCTO #5521]
I created a brief note in the do_fetch subsection of the
"Taking a Closer Look" section to deal with how the build
system uses checksums during do_fetch to re-execute stuff
if a file:// listed in the SRC_URI has had its contents
modified.
(From yocto-docs rev: 7b857635f2663af7c1d5e8aa87239472a5b47919)
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>
Fixes [YOCTO #6064]
The directory name for the conf/distro/<distro>.conf file was
wrong. It was conf/<distro>.conf. I have corrected it.
(From yocto-docs rev: c8ae4fb23e76a45bbbd4e673311b3ec74980644d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Minor fixes throughout.
(From yocto-docs rev: d44ae0da21d84acbe1556824e228c7ab0af1ba2c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the adt-manual in the "Optionally Building a Toolchain Installer"
setion, I added some basic advantage information for building a
toolchain installer using bitbake image -c populate_sdk.
In the ref-manual, I added cross-referencing to this basic information
in several strategic areas: "SDK Generation", the populate_sdk class
reference section, the populate_sdk_* class reference section, and the
"Cross-Development Toolchain Generation" sections.
Finally, I also put in documentation for a new class called
autotools-brokensep.
(From yocto-docs rev: cde7dd2fbd7bdc0d71dc678ee7a5422459654287)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5410]
I updated the figure that shows what do_rootfs does to create
the image. The new addition is the creation of the .manifest file
that lists out package information in the image. Supporting text
was also added in the section.
The updated figure was needed in both the ref-manual and
mega-manual figures folders.
Also, part of the fix included a new variable description for the
IMAGE_MANIFEST variable.
(From yocto-docs rev: 770448e0e8ce2e2c517ced5e71f5a916fefe5cf2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5755]
Put a link in the SDK section of the "Closer Look" chapter. The
link goes back to the SDKPATH variable.
(From yocto-docs rev: 7420da33bfa89625b5bbf592416c7f07780f8285)
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>
Patch applied from Robert P. J. Day that basically amounted to
a good review of this section. Robert caught several typos and
small writing issues throughout the section.
(From yocto-docs rev: e44bb5897dbcc7e96bfbc730f6abe87cc2df2f3f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
changed the wording for where the DEPLOY_DIR_IMAGE directory
points to per Paul Eggleton's suggestion.
(From yocto-docs rev: eaa48e4dc54bf07431d389de6064329f2173ea68)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5035]
By default, the DL_DIR does not get files from Git repositories
that are suitable for mirroring. There is a work-around by
using the BB_GENERATE_MIRROR_TARBALLS variable, which, when
set, causes the build system to generate tarballs for the
Git repositories and place them in the DL_DIR.
To address this, I added a new variable description for the
BB_GENERATE_MIRROR_TARBALLS varible, updated the DL_DIR
variable to indicate that "out-of-the-box" the YP puts suitable
mirror files into the DL_DIR for everthing except Git
repositories.
Some other sections were updated where discussion revolved around
pulling down source files. The QS had a spot where the
BB_GENERATE_MIRROR_TARBALLS variable was actually used in an
example. And, the expanded discussion on the BitBake process
had a couple spots that deserved a mention.
(From yocto-docs rev: 1539ff13222449ba60bfaaaac4fe1e8a795b0039)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2808]
I updated the figure to not call out the SDK environment setup
script as it is part of the .sh file. The figure was placed
in the "figures" directory of the ref-manual and the
mega-manual.
Also, I removed the duplicated variable descriptions and referenced
these descriptions in the "Application Development SDK" section,
which is further down in the manual. The descriptions have more
to do with where output is placed.
(From yocto-docs rev: 256bb1447b571299b57c657bf030d5b4f033fb5f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2808]
Updated the figure and placed it in the folders area for both
the ref-manual and mega-manual. I had to add the
DEPLOY_DIR_IMAGE variable and create a new machine-specific
directory below deploy. The text had to be adjusted to reflect
this change as well.
Also, created a new variable entry for DEPLOY_DIR_IMAGE for
the glossary of the ref-manual.
(From yocto-docs rev: 50a68810f854b32fa5dba477eafa8fd1eebbd7a4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2808]
Applied some Eggleton review edits to the image generation section.
Minor tweaks and a cross-reference to the read-only root
filesystem section in the dev-manual.
(From yocto-docs rev: e41a08872e398d10c452bb5e1f1e6af41a525ab2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2808]
New section on the deeper look at SDK generation. This is a first
draft.
(From yocto-docs rev: 54438f1a9dac847d2d03ca1cb9a2b00de9369dbe)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2808]
Applied review comments to the section from Paul Eggleton. I
updated the figure and the text areas.
(From yocto-docs rev: a89b126861e8ee2f43a89afb0a16e56659270fee)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2808]
Did a self-edit here to try and straighten out how I am mapping
the variables to the actual figure.
(From yocto-docs rev: 82e94d8a8221bbf2eb5feb19a6642907b4ff490b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2808]
Added the first draft of the expanded explanation for generating
an image.
(From yocto-docs rev: 72e4db25d89cad62e1cd9ee1d638af374ec1bfc0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2808]
The Build Directory should be inside the BB blue box here and
not outside of it. Adjusted the figure, which resides in
the figures directory of both the ref-manual and the
mega-manual. Also had to widen the image footprint to make
it readable.
(From yocto-docs rev: b4ff9292cf629894fda6ad4a29fbdaad85f43cd0)
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>
Fixes [YOCTO #2808]
I extracted the section that takes a closer look at the YP
development process into its own chapter. Feedback during the
review indicated that this information should not be buried as
it was in a section but rather pulled higher out for visibility.
So, The changes create a new chapter three that is dedicated to
this topic.
(From yocto-docs rev: 32c66976b6b84787d14d6174dab843862a0d184b)
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