The description had gone stale and was referencing a linux
yocto kernel we don't support and BSPs we don't support. Updated
it.
(From yocto-docs rev: 5041a2a26d703a885437abcedb24c7600d5365cd)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Recently a number of changes have happened on the implementation
side of some image formats, and a few have been renamed.
The u-boot image signing code is now always available and no
longer in a stand-alone file. The vmdk/mdi/qcow2 images have
been removed and are now just a conversion type that is applied
to wic images.
Reported-by: Tom Rini <trini@konsulko.com>
(From yocto-docs rev: ce86da3d48507cee12208e0138c285b4be83d8cd)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11968]
Purged all occurrences of the "oe-init-build-env-memres" script
from the YP documentation set. Occurrences in a lot of places.
The BBSERVER variable was also impacted and had to have the
definition updated.
(From yocto-docs rev: 274b05108d1bc53df20c11ab2efa15363bce23da)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Discovered this item in the front of the glossary was commented
out and not showing up so the user did not have the option to
click on "N" to quickly get to the "N" entries, which did exist
and show up. Uncommented it and put the proper beginning "N"
variable in as the start.
(From yocto-docs rev: 6d51dfb9de53db1222f68a6f0325eaad1a12cd6b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11762]
Added a link from variable to new virtual providers
section.
(From yocto-docs rev: d87726cf4962ca093c63d23d9e04f41d448c9594)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added new description and created a link for an
existing occurance of the variable.
(From yocto-docs rev: 9ab6e6aed685c9419cb7df3df3ab029033d9ba0e)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The description suggested the reader see the
meta/poky/conf/local.conf.sample.extended file for more understanding
on INITRAMFS_IMAGE. The actual file is
meta-poky/conf/local.conf.sample.extended.
(From yocto-docs rev: 80b474d3417e88a47d1317b2af6552698e907b80)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11579]
I removed the sentence about throwing an error or warning.
(From yocto-docs rev: cfa3b1559122ec9e927ccd34afa0e26e877486f9)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Moving the "Yocto Project Terms" section from the dev-manual
to the ref-manual broke the links to the "Metadata" term.
I fixed these.
(From yocto-docs rev: 190da4b4d44952d141db26ca72b5bc1a52d77023)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Moving the "Yocto Project Terms" section from the dev-manual to the
ref-manual broke several links to the id "build-directory". I fixed
these to reference into the ref-manual now.
(From yocto-docs rev: debe2ae8ce203ebe0f1cee0de54124c15df8bb7e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11600]
Removed the example. It was not needed.
(From yocto-docs rev: 402bb173b00a665fb55a8f740a4dbe60ead57f25)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11600]
"configure" and "cmake" are not do_* tasks of BitBake. I updated
the formatting of these programs and removed links that were to
the tasks in the reference manual.
(From yocto-docs rev: 2605c7378f6b4b49c2e2baaf159fd2c289d83a1a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11600]
Made some technical corrections to the PACKAGECONFIG_CONFARGS
variable description in the glossary.
(From yocto-docs rev: c422783984748f170943eab418bfa7d0111fa352)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11579]
Added a new description for the LAYERRECOMMENDS variable.
(From yocto-docs rev: 3004a5724c4ea7165e4f749f9c9237ee1fbd89f5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11579]
The syntax for specifying a layer version was incorrect. I
have added an explanation for the correct syntax and provided
an example.
(From yocto-docs rev: 5703fb2f8b9d3df408c596603b8b8416597fc67a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9001]
Updated the image-live class description to specifically mention
creating *.iso and *.hddimg images as "live" images. Provided more
explanation about usage through the NOISO and NOHDD variables.
Also, provided a cross-referencing link back to the updated
image-live class from the EFI_PROVIDERS variable.
(From yocto-docs rev: 788061b2911339c8396b798a0ab5635ab5bb89e1)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11498]
I enhanced the description of the INHERIT variable's glossary
description to provide more detail. I also included a link into the
section of the BB manual where INHERIT is described.
(From yocto-docs rev: 663cde3cf05ebf564ff3a28cd37b696be2f91ad8)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Entry added for HOSTTOOLS and HOSTTOOLS_NONFATAL.
(From yocto-docs rev: c766920a13071c1bb46a195ea07be38962d2e12d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10995]
I implemented various wording changes based on feedback from the
review. One section title changes so some links in the ref-manual
and the dev-manual needed updating as well.
(From yocto-docs rev: 43a35a311a006d47db50602822e44ab431ca3e43)
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 #10995]
I applied some revisions to the related sections for incrementing
a binary package version and revision sections. Mainly clarified
terminology and pulled the sections into one single section head.
I also cleaned up referencing to all these sections throughout the
YP manual set (i.e. the ref-manual).
(From yocto-docs rev: 7deda18dd496cc383c5de71a10f2b11b1ca0688f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10995]
For the dev-manual, I added a new section on incrementing package
revision numbers that explains how the build system uses various
variables to create linearly numbered revisions for packages.
For the ref-manual, I cross-referenced into the new section from the
AUTOSRC and SRCREV variables.
(From yocto-docs rev: 53c3092e0f0293f4db0a88659abb4cf1c93f208c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11274]
When a post-installation or pre-installation script uses tools that
have dependencies, you need to specify the tools using the new
PACKAGE_WRITE_DEPS variable. I added this information at the end
of the "Post Installtion Scripts" section in the dev-manual.
I also added a new variable entry for the PACKAGE_WRITE_DEPS variable
in the glossary.
(From yocto-docs rev: 4d130b63cba5ebabd4af52b62421d387a4b54353)
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>
Fixes [YOCTO #11017]
There is no current way to specify or list plug-in dependencies
when building a Wic image. The variable WKS_FILE_DEPENDS was introduced
to allow the user to use this in the recipe building the image.
I added a description and example of the variable to the ref-manual
variable glossary. I also cross-referenced the variable in the
"Plug-ins" section of the dev-manual to point to the variable for
more information.
(From yocto-docs rev: 5a1072499ab80f74ffec6af2cc0b2f1987843a25)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11021]
The "Maintaining Open Source License Compliance During Your
Product's Lifecycle" section in the dev manual covers use of
archiver.bbclass, but is missing mention of the filtering
options (e.g COPYLEFT_LICENSE_INCLUDE, COPYLEFT_LICENSE_EXCLUDE
and COPYLEFT_RECIPE_TYPES). I added descriptions for these
three. During the write-up, Paul noticed a couple other variables
missing: COPYLEFT_PN_INCLUDE and COPYLEFT_PN_EXCLUDE. I also
added descriptions for these two variables.
(From yocto-docs rev: 450311037ea3048d30057c0b9d294efd33db2d3c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11010]
The second example was incorrect in the glossary entry. Instead
of "1" an image name place holder was in the example. I put "1"
in there.
(From yocto-docs rev: 00ab787d0d90da5c6d384c3669e804c9b2baca53)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #6132]
No mention of how to make the target directory /var/log
persistent. I added a note to the "post-install-logging"
image feature that points to the new VOLATILE_LOG_DIR
variable description, which I added to the glossary.
(From yocto-docs rev: 5d2bdf49e569e44d02602501d72418f04dbe6e4a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7096]
We did not document how to create an initramfs image to be included
with a kernel build. Various variables sort of inferred the
knowledge. I created a new section in the "Common Tasks" section
of the dev-manual that describes how to create an initramfs image.
Also, I updated the kernel.bbclass reference section to point back
to the new "how-to" section.
Finally, I also created a bunch of cross-reference links from various
related variables back to the new "how-to" section.
(From yocto-docs rev: 289dfbd5d24241e42446a043104eecd6dca76f13)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This term was incorrect and I have replaced it with the
term "partitioned."
(From yocto-docs rev: 50dd5c6994a2f799fdaf1ccbf7138b0074e981ee)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This new variable points to the location of the wics kickstart
file.
(From yocto-docs rev: 80d18224140f95fdca0b4efad8f6a6e545ee4d56)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10717]
Now that multiple images can be built, the KERNEL_IMAGE_BASE_NAME
no longer requires "${KERNEL_IMAGETYPE}" as part of its default
value. I have removed this portion of the default definition
described in the glossary.
(From yocto-docs rev: 713b3c141dfb66fc3852b5a997a7fc19d494e97b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10692]
I updated the STAGING_DIR variable description to have a reference
to the SYSROOT_DIRS variable as well as the "Sharing Files
Between Recipes" section of the dev-manual.
I also updated the "Sharing Files Between Recipes" section so
that the role of SYSROOT_DIRS is explained and actually used
in an example to add another directory.
(From yocto-docs rev: 6539fcf632cfa3f076f874535ee9fc7ac291fbce)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #8584]
This fix essentially had to document how to add the API
documentation to the standard SDK. The fix required adding a
new appendix to the SDK manual on how to customize that
standard SDK. I could not put just one topic in a new appendix
so I also added a sub-section on how to add indidual packages
to the standard SDK.
Other changes here were the introduction of a new file for the new
appendix, updated the mega-manual.xml file so that it would include
the new chapter when the MM was built. Finally, I added some
cross-referencing to the new appendix from the TOOLCHAIN_HOST_TASK
and TOOLCHAIN_TARGET_TASK variables. And a cross reference from the
distro features section on the api-documentation bullet.
(From yocto-docs rev: 1fb4321ae42253d1fc9602496b5e9e8b495197dd)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10445]
Pointed out that the EXTENDPKGV variable is hard to locate in the
BB manual. Firstly, we don't document that variable in the
BB manual.... maybe we should. For the ref-manual, however, it is
barely referenced in a side example from the dev-manual. So, I
updated the RDEPENDS variable to have a "Tip" box in the area where
it is shown how to use the package version as part of the RDEPENDs
variable.
(From yocto-docs rev: 7aff5df538c27cf3c2700538e46e723cdb5d9986)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This variable is now redundant due to the way these image
files are staged now. The variable does not need to be
in the glossary. Removing the images is now the default
behavior.
Author: Joshua Lock <joshua.g.lock@intel.com>
(From yocto-docs rev: 049c371b44d3ef68def4ead7d1db8bf982d23c57)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The way these old image files are staged now makes removing them
the default behavior. Thus, this variable has become redundant.
I added a note indicating such.
(From yocto-docs rev: e1db620fdf741b46e54cf1a3715597f81a811818)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
