Fixes [YOCTO #2444]
Several areas affected by the reference BSP "beagleboard"
being replaced by "beaglebone".
(From yocto-docs rev: 2f02b570e1ebcf0469871b67a029b65fa8b285f2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Turns out that the user does not set these variables.
(From yocto-docs rev: b016906dad7e3d7856935e83e5c9b09cfa399caa)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5159]
In the dev-manual, I located instances where a note about using
VIRTURAL-RUNTIME_initscripts = "" in the local.conf file would
be appropriate. Three areas updated.
In the ref-manual, I located the note in the systemd.bbclass
section and the variable descriptions for SYSTEM_AUTO_ENABLE,
SYSTEM_PACKAGES, and SYSTEMD_SERVICE.
(From yocto-docs rev: 57b0acf2f3f8159b635b42dcffa129f7d945eb81)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #3686]
In the dev-manual, I created a new section called
"Making Images More Secure." The section explains in general
how to enable the security flags.
In the ref-manual, I updated the CFLAGS variable to point to the
new section.
(From yocto-docs rev: 3ed91a46eaf5c1fdf84369ea69951775d87a42da)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5861]
Added a note to the SDKMACHINE glossary variable stating that you
can't set the variable in the distribution configuration file and if
you do, it won't get recognized.
(From yocto-docs rev: 8cdc14e553586f6a754dfc3a91cc9741eb1784ee)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #6045]
Added a sentence to the end of the variable's description indicating
how to enable building an ISO.
(From yocto-docs rev: 2806518155fdbb42b392a64b57a67c9259640f79)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The do_package_write task has been removed leaving only
do_package_write_* tasks. This variable description had an
example using that obsoleted name. I changed it to
do_package_write_ipk.
(From yocto-docs rev: ec1c33a867f539cd83d672845075f2437cd917ed)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I did not eliminate this variable but rather changed the description
to indicate that it has been deprecated and that the user should now
use a PR Service to do this stuff. There were several areas in the
YP manual set that used the variable in code. I just deleted those
lines from the code.
(From yocto-docs rev: 88a075e6306349e5f8c0d53b5288ef1e64956cd3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The "sum.jffs2" option was renamed to "jffs2.sum" to better reflect
its purpose. I updated the list of options for the IMAGE_TYPES
variable to reflect the change.
(From yocto-docs rev: 4226ff4aa96eed1d51753d5dee72c6264ee2d7f7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The PACKAGE_GROUP variable was renamed to FEATURE_PACKAGES.
I added that fact to the description and pointed the reader off to
the new FEATURE_PACKAGES variable.
Added a new variable description for FEATURE_PACKAGES.
(From yocto-docs rev: f7a0a17c211cfc8f885771a5221bf3b59bc6bf95)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #1562]
In the dev-manual, I created a new section called "Using the
Error Reporting Tool" that describes how to use this feature.
The text was based on information I received from Andreea Proca.
In the ref-manual, I added a new variable entry for ERR_REPORT_DIR
in the glossary and a new report-error class in the class chapter.
(From yocto-docs rev: 70a5538fefcc1b77958fe4b2f29be00354f4137a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5442]
Updated the TMPDIR variable to call out the scenario where a user
might want to separtely set TMPDIR to a local drive and thus be
able to have the Build Directory on NFS.
Updated the "Build Directory" term with a note indicating that by
default, TMPDIR is inside the Build Directory and thus cannot be
on NFS. However, the user is able to by-pass that per setting
TMPDIR separately outside of the Build Directory.
(From yocto-docs rev: a5a308c512a3f4285bce16f17974dbf6b67432b2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5442]
Updated the description to note that TMPDIR cannot be on NFS
since it has issues that mess up the build process.
(From yocto-docs rev: a2fa1c8a23ee7a26fa362e089d84747b4cb4618b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2528]
The defaults for BB_NUMBER_THREADS and PARALLEL_MAKE are now
automatically set to the build host's number of processor cores.
I updated the "Building and Image" section in the Quick Start
to state that. I also updated the PARALLEL_MAKE variable.
(From yocto-docs rev: 2069c96d2410605c089da4eede2c7b4f9a7b704a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2424]
Some imgage names were cleaned up to have more meaningful names.
These doc changes here take care of changing "core-image-basic"
to "core-image-full-cmdline".
Five instances changed.
(From yocto-docs rev: b758f9645e66867b5728da1dd989bae70a216fcc)
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 #5931]
Added descriptions for the following variables in the glossary:
* MODULE_IMAGE_BASE_NAME
* KERNEL_IMAGE_BASE_NAME
* PKGE
* PKGV
* PKGR
* PKG
The first two are for the bug. The remainder needed to be added
as they were referenced from the first two (except for PKG, which
I was told needed to be added anyway. I also fixed a couple formatting
issues in there for some other variables.
(From yocto-docs rev: c488b57a2ae5a5d1ef4b0da0ecaa9589c3106a45)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #4072]
Added the new variable CONFIG_INITRAMFS_SOURCE, which points to the
initramfs source. I also added information to the
INITRAMFS_IMAGE_BUNDLE variable noting how its use can avoid
circular dependencies as described by the bug.
(From yocto-docs rev: 73267642299d1164eeee5866e7ca7006c56260e5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added more detail about this directory. I stated that it
is the top-level build directory and it is set when you
initialize your build environment with one of the init scripts.
(From yocto-docs rev: 839d704e7096dba039b17e5989cad7314732e6db)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5855]
Added this new variable to the glossary.
(From yocto-docs rev: 72e31962ecb3289c3f986ecb54a5590b5101067d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed a typo and also added a bit of information to be sure
the user understands this affects the local host.
(From yocto-docs rev: 4111ac06276f2d1b134176683c0f4d446ba35ef9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5801]
First draft of this description.
(From yocto-docs rev: 412d0cc7dbb74ece45940c40fbb617217ab88d2d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Better wording. "holds" could be confusing for some.
(From yocto-docs rev: d94a1be421f39637b1d760dad401fdfb54e20b07)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5762]
Applied some more detail based on Laszlo's review comments.
(From yocto-docs rev: eb8d11504d6c22dfd9620422df3fc31cfcebb00c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5762]
Initial draft of this variable in the glossary.
Reported-by: Laszlo Papp <lpapp@kde.org>
(From yocto-docs rev: fb603925de6760f620f9f2832ad6cb4aad3acaae)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5755]
I added this variable to the glossary chapter.
Reported-by: Laszlo Papp <lpapp@kde.org>
(From yocto-docs rev: 0ad0e2ca351ebc52c92404d71502455cf7c042c9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Noted that if these variables are not set, they both default
to the number of cores the build system has.
(From yocto-docs rev: 8654aeb91f734628bffda9d5de0cdc9ea27d3f67)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #4942]
Added a note to the variable description stating that if the user
does not set TCMODE to "default", it is up to them to verify that
components are compatible with the toolchain.
(From yocto-docs rev: e67d7635c1d749e65aaef0d4cc6576a3ee312ddd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed the machine-dependent and machine-independent descriptions.
Created matching description from the "Writing a New Recipe"
section.
(From yocto-docs rev: 89a00beb81be60668abfdd67b13f5ee5bdc7ea1c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some minor changes.
(From yocto-docs rev: e545ee26e7e6c827c5ee6d7061f01eda58c9c82b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These variable descriptions were identical in the ref-manual.
I found out some reasoning behind that and added a bit of
explanation to the entries.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 5c786b5b62fefb959ed7c13bb83e718a9eb22189)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #4072]
Added a new description for the INITRAMFS_IMAGE variable. Also,
made a formatting fix to the INITRAMFS_IMAGE_BUNDLE variable.
(From yocto-docs rev: 87c5c0b1554233c3ce1c41291d852021ec62e0dc)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #4072]
Added that the kernel class sets the variable to a null string
by default.
(From yocto-docs rev: d00ea912ad9ad1558546496e72fca229b9b8081b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #4072]
First draft of a new variable description for
INITRAMFS_IMAGE_BUNDLE.
(From yocto-docs rev: 4f1ac2840750fa35afa7584d28464fd539883399)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5684]
Added a clause to note that the tarballs saved to the DL_DIR area
include the Git metadata.
Reported-by: Laszlo Papp <lpapp@kde.org>
(From yocto-docs rev: 76cbb8a149b9fda6879f9dfc6a17dab992325e94)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The directory is not a temporary thing.
(From yocto-docs rev: 4a10a64866e9e769a2113f95943d69cb79543d6e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Used a better word to describe the argument list.
(From yocto-docs rev: e31852ee32b2f5166cc766a2cdfe07616dd259db)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Three broken cross-references to the "qmake_base" class existed
in the variables chapter. The actual class "qmake_base" is
listed as part of the "qmake*" class so there is no tag taking
a user to the exact "qmake_base" class. Changed the tag to
"ref-classes-qmake*".
(From yocto-docs rev: c13e441e9bbe3a451a59e5123b772426d36183ae)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a note at the bottom clearly stating TAR files are never
used as a substitute for RPM, DEB, or IPK files when generating
your image or SDK.
(From yocto-docs rev: 8d45ac58926de4fb01156eccd53cfa0f3eca4d9d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This was pathetic and needed updating.
(From yocto-docs rev: 30996e88a8ca26d57f748fc8232bb26e0ff6c433)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I discovered some issues with this description. Should be
referencing the Build Directory for where the local.conf file
is and not the Source Directory. Also, the link to the
package.bbclass section was mis-titled.
(From yocto-docs rev: 38daa12eae5303a70cf210f8669e416b161b38bc)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Sorting out who assumes what.
(From yocto-docs rev: f02312e300ce7749a7a5347538ece26f5cfa76bf)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed the links in the icecc class that linked into ICECC_CC,
ICECC_CXX, and ICECC_VERSION so they don't link anymore but rather
give a very brief explanation of what the variable does.
Removed the above three variables from the variable glossary.
These are not BitBake variables and we should not document them.
(From yocto-docs rev: f4f79d27c0d1417ff683381f18f165cda3a8a02e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Minor changes to the SYSTEMD_PACKAGES, SYSTEMD_SERVICE, and
SYSTEMD_AUTO_ENABLE variables.
(From yocto-docs rev: 838eb9088ec20a265e785d4203e4e5084fd4a7c4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Modifications to ccache, chrpath, clutter, cross, cross-canadian,
crosssdk, and debian classes.
Added a new variable to the glossary for LEAD_SONAME.
(From yocto-docs rev: f27b6315f839a731017866106578e664c6c86982)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Also had to update four instances in the variables glossary where
links to the section for the class became misnamed due to
stripping out the excess stuff from the class section heading.
(From yocto-docs rev: d98d3848327950c5c5cfc8559379e56c97157ad2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a note to the existing IMAGE_FSTYPES variable based on
using "live" as an image type. Need to be sure that appears
before inherit line in the recipe.
(From yocto-docs rev: 1fc45b2bc7c70f00882d495d659830b94eb7d2df)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Told where to set this variable.
(From yocto-docs rev: f95fb5821383721da6a63bb8eb74807e89e6b21d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Created glossary entries for the GRUB_GFXSERIAL, LABELS,
APPEND, GRUB_OPTS, and GRUB_TIMEOUT variables.
(From yocto-docs rev: 31bcc25866525ef998bc01e11ab9ddb0601b8ded)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Due to the way in which IMAGE_FSTYPES is processed, it is not possible to
modify it using _append or _prepend. Therefore add a note to the manual to
warn users in case they stumble on this issue.
(From yocto-docs rev: 164aee65a6796ccc24c2734bb7440a8d6531f180)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I applied some review edits to the USERADD_PACKAGES and
USERADD_PARAM variables from Paul. Additionally, I added descriptions
for the GROUPADD_PARAM and GROUPMEMS_PARAM variables.
(From yocto-docs rev: 0c52a79efb2cf7c708ea989ab307be04f27484dc)
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: 4eb9a5c6df085e57e7885e12fdbdcc85f61c101d)
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: 6ace08dcbaa08fd13d4d8f49d34dd90240e65761)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This needed some work to be more descriptive.
(From yocto-docs rev: 2ea324c84f5aaaf3c30d1c71396fa3d5372669a0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Took care of some quoting for the "x11" feature and also a
messed up sentence in the second paragraph.
(From yocto-docs rev: ed71135edbdd8de02cbb6d7cc972aab0e269e4cb)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
The etcdir string was replaced by sysconfdir.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 095a9226171189f17c0671b05196cef58da33732)
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>
Minor word changes and formats.
(From yocto-docs rev: 82c096cd79e7de8cb8c4af4be02b6838e82f06d6)
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>
Re-worded the first sentence.
(From yocto-docs rev: 1b6798a8de3d73418b4377cf3b9654dfea4caed8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added minor wording to the note.
(From yocto-docs rev: 1c575ad8ef6823a66adcc0b4e223ecb55226f13f)
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>
The tool has only three utilities the user can pick from.
The previous description implied unlimited tools.
(From yocto-docs rev: aa9b1c7db1bb52fd903886dc4c47368ebb926905)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #4980]
Added a new glossary entry for OEROOT.
Added significant information to the local.conf and bblayers.conf
reference sections to describe how the root build directory is
derived.
Also, some unrelated formatting to the DL_DIR variable description
was mixed in here because I forgot to commit that separatey and it
lives in the same variables.xml file.
(From yocto-docs rev: c397a31f5b0d3f6257657119a4e81b4fbdc3800c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Update the manuals to reflect the recent replacement of atom-pc with
genericx86.
(From yocto-docs rev: 8f77006d74b77000f56b64581cb5f6474f53a4f1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some things were not in alphabetical order.
(From yocto-docs rev: e7d96d5eecaa74d680a4495a21f86a7776852c48)
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>
Some review edits based on Paul's review.
(From yocto-docs rev: d6ff6399cb02b045a7a35a2c87d5f62a25612c3b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #4079]
I have added variable descriptions for NO_RECOMMENDATIONS and
PACKAGE_EXCLUDE. I updated the BAD_RECOMMENDATIONS and the
RRECOMMENDS variables.
(From yocto-docs rev: 3b5b44d3db9e723cd9836ddbd4177c2ab2e1d663)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I have added more information to both these variables to help
explain their use better. Based on email from Paul Eggleton.
Each entry now features a simple example.
(From yocto-docs rev: 1ec67c639f15259ac67d5591d1d7a23522b0a822)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I changed the description to note that the PE variable is unset
by default.
(From yocto-docs rev: fe3655121e2796e50b8b3372df06cdf8341a2202)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed some wordings in the ADT manual to remove "Intel-based"
so as not to be biased.
Added "x86" to qualify the types of systems in the toolchain
examples.
Added minor wording to the IMAGE_TYPES variable.
Changed some wording for the IPK_FEED_URIS varilable.
(From yocto-docs rev: 1fa7e0000591bec7e3d0b682df02b95dbee3d4f1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Updated the insane.bbclass section to move the note at the
end about using ERROR_QA and WARN_QA to control how the
checks are reported to the front of the section.
* Added new variable entries for WARN_QA and ERROR_QA.
(From yocto-docs rev: 6f220d1ba3d44a1bba2f1ac882cdf6b601ddc5bb)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Updated some links in the insane.bbclass sectioni so they
now point to some new variables.
* Added glossary descriptions for PKGD, PKGDEST, and
INCOMPATIBLE_LICENSE.
* Added a paragraph to the LICENSE variable to describe
situations where the output might have components whose
licensing is from two different licenses (licensing on
a per-package basis).
(From yocto-docs rev: b8dd3b3d5cb912ed7c5d3c9b6c01d93347e95b84)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #4788]
Added a bunch of new checks to the list of checks in this
class. I also recast the section head to just have the
class file as the section heading. This resulted in a link
that needed changed.
(From yocto-docs rev: 4a4df80c0b6012ad09ea526d2893e729aa06965b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied some minor review comments from Paul for some variables
in the reference.
(From yocto-docs rev: 231031c291367f3b8f6b1f44d4a0b1804d8e9d9f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
When I added this variable, I cut-and-pasted from the
INSANE_SKIP variable, which appears directly in front of
this new variable. I failed to change the name of the
variable from the copied INSANE_SKIP to IPK_FEED_URIS.
Fixed.
(From yocto-docs rev: 3138ba59d90dbdd11be524598c3996a6824bc424)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Scott Rifenbark
Trevor Woerner
Robert P. J. Day
Darren Hart