I noticed that chapter 10 of the ref-manual still had
"Reference: Features" as the title. This is left over from way
back. I changed that chapter title to "Features." Next, I
noticed an inconsistency with some sub-section titles.
I changed the "Images" title into "Image Features." This affected
several links across the doc set so I had to update those
cross-references as well so they have the latest section title
as part of the reference.
(From yocto-docs rev: b68f009a92e0e24802e367d98cf66e15ba1cd364)
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>
I updated the MACHINE_FEATURES, DISTRO_FEATURES, and
COMBINED_FEATURES variable descriptions to better reflect what
they actually do. Also, fixed two occurences of IrDA in the
features lists section.
(From yocto-docs rev: af79b0b3bc88ca0811d488c7c5d6b5407de808a7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Very rough draft for this new variable. It will likely
change.
(From yocto-docs rev: b535542975ae469753cb27ce59f9f716167384fb)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added glossary definitions for BUGTRACKER and
CLASSOVERRIDE.
(From yocto-docs rev: 79c10f1cf0f18429eb41b035ed60264b48549e9a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The BB_DANGLINGAPPENDS_WARNONLY variable seems to be able
to be set using "1", "yes", and "true". And, it is set using
these various methods throughout the poky metadata. I guess it
has caused a bit of confusion so I have added the fact to the
description.
Reporte-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 651e09aba67f9d62ce005529f16a776c0ab593f1)
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>
Fixes [YOCTO #5408]
Some edits to remove a link to the YP Metadata definition.
The metadata referred to here is for opkg only.
(From yocto-docs rev: 777969fb3b74e638fedb638d161e2f92ac0a5f4c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5408]
As part of the fix for this bug, I have added a description of this
variable to the glossary.
(From yocto-docs rev: ad988c82b364bb0c629bcb2ce04f99e0e371622e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The formatting for the "Caution" boxes was poor. There was no
apparent reason in the style guide why these types of admonitions
should appear any different than "Notes" or "Tips", which look
fine. I could not devise a .css solution so I tricked the
formatting by using the <title></title> tags in combination with
a <note></note> pair. Basically dumped the <caution></caution>
tag pair. It looks okay now.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: a53d6f0b3a22cfd87f841c03452b5ebce2b1b474)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This variable is only used when building an image using Hob.
The description implied otherwise. I clearly state this now.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 12b671aec1df367c107d906bbefb44da56b2adec)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5368]
Applied some review comments from Laszlo to the new description.
I added an example.
Reported-by: Laszlo Papp <lpapp@kde.org>
(From yocto-docs rev: 5961cde05aff967f8db7cd10cd9b46c147c62f83)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5368]
The current explanation was ambiguous regarging the term
"subset". I have rewritten to be clear.
Reported-by: Laszlo Papp <lpapp@kde.org>
(From yocto-docs rev: 3bf41e856c3d9828d5c9cd6d70467e88a4af575f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5214]
Applied some updates to better describe the variable's use
model.
(From yocto-docs rev: 9a66296f090f4ef023b3b5ae6f237676b6e9bd87)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5295]
Added three new variables to the glossary: UBOOT_MACHINE,
UBOOT_ENTRYPOINT, and UBOOT_LOADADDRESS.
(From yocto-docs rev: 48d52dfd4c395cdfeb95878cbd7f128adba8e398)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5063]
Provided a brief note that tells the user how to set BBPATH
if they are going to run BitBake from any directory outside of
the build directory.
(From yocto-docs rev: 89b31f252237113638acea4634a65ea9ff241b5e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Review edits from Paul Egglegon applied to the Migrating to
1.5 section.
Also, part of the review affected the COMPLEMENTARY_GLOB variable
entry in the glossary.
(From yocto-docs rev: 941a388f45c99403f5cb480bf3e5aae55a800994)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied review changes to the following variables:
IMAGE_NAME
DATETIME
SDK_ARCH
IMAGE_BASENAME
TUNE_PKGARCH
PACKAGE_GROUP
COMPLEMENTARY_GLOB
BUSYBOX_SPLIT_SUID
Also, reformatted some 1.5 package version requirements into a
list rather than a lazy literallayout tag.
Provided some new wording for the "Directory Layout Changes"
section in the Migration chapter.
(From yocto-docs rev: 60c3a905dd9212f1b4f6969341640a0726342d11)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
1. Created the first draft of the new migration section for
moving to the YP 1.5 release.
2. Created new variable glossary descriptions for the
SDK_NAME, IMAGE_NAME, and DATETIME variables.
(From yocto-docs rev: 26e6a7675183b49a0ee8059d81218dbc5cd14bd4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied a second round of review edits from Paul Eggleton
for the new "Performing Automated Runtime Testing" section.
I did some reorganization and some minor wording changes.
(From yocto-docs rev: fa8f8e5f0f6c1377a4fcafcd3d933af15ac01ff3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed the glossary entry for DESTDIR as this is a Makefile
variable. Also, updated the reference sentence to DESTDIR
that was in the autotools.bbclass section.
(From yocto-docs rev: 16900d95dbbd406ac93cd22f2b14b2346668beb3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a note indicating that the variable might be cleared out
if there are problems running Make.
(From yocto-docs rev: 861921b86c48de2267ccd32ab3f3424a98eb8ed1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section and variables for performing automated runtime tests
on images was reviewed by Paul Eggleton. The suggested changes
were made.
(From yocto-docs rev: c2f84ea3c162892e4da3df30fb833f88bab3d3cc)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added variable descriptions for TEST_SUITES and
TEST_QEMUBOOT_TIMEOUT.
(From yocto-docs rev: 8ca24bbb5388040a4aa5b70bac9babf1805bbb6e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #4987]
Added some versioning operators to the RCONFLICTS, RREPLACES,
and RRECOMMENDS variables. I am using the same base text to
get this information across. Because it is a referenced
glossary, the duplication is acceptable.
(From yocto-docs rev: 47613f962c945e06710ba2e14e0eb5f1f11d0336)
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 #5035]
Added a new glossary entry for BB_GENERATE_MIRROR_TARBALLS
and updated the DL_DIR entry to note the ability to get these
tarballs into DL_DIR. Cross-referenced the new variable
from DL_DIR as well.
(From yocto-docs rev: 361000877f2a13b13154e437a6c28839fa58cd5e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Several glossary entries were not in the correct alphabeitical
order.
(From yocto-docs rev: 0b2559cca79a74043e73fd14eba330025e84f30a)
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 #4987]
This variable supports some boolean operators that we are not
showing for supporting versioned dependencies. I added the
explanation for them. There will be other variables affected
later once we settle on the changes here.
(From yocto-docs rev: e5c1e66d670c708012bd5ab51aa94f87426f57e2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2808]
Applied some review comments to the ROOTFS_POSTPROCESS_COMMAND
and IMAGE_POSTPROCESS_COMMAND variable descriptions in the
glossary. Review comments from Paul Eggleton.
(From yocto-docs rev: 9a9a0e04261d2f2e470e49b89bb9e2c6bc56d736)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
