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>
The value for USERADD_ERROR_DYNAMIC changed from "1" to "error"
to activate this variable. Also, the value "warn" is used
to cause a warning to be issued. I updated the variable
description to reflect this.
For the USERADDEXTENSION variable, I updated the [doc] string
to use proper quote marks. I was not nesting these properly.
(From yocto-docs rev: f21277b3887134611fc567da05e8a590ecb0d7af)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10377]
Linkified the STAGING_DIR_NATIVE item in the the
SYSROOT_DIRS_NATIVE glossary entry.
(From yocto-docs rev: e02ecfac949b92ec32a621fccb0d1663bb7816ad)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10377]
Some minor wordsmithing. Also added a new note to the
SYSROOT_DIRS_NATIVE variable.
(From yocto-docs rev: 459666b01b8d6d8212a59c877ea6c324511a5883)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10377]
Provided links back into the do_populate_sysroot task and other
key variables. I updated the SYSROOT_DIRS, SYSROOT_DIRS_BLACKLIST,
and SYSROOT_DIRS_NATIVE variables.
(From yocto-docs rev: 23ed80e4884b00e303a15d0d191bd0dca385b064)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I basically moved the note from the bottome to a position
within the bulleted list.
Fixes [YOCTO #10348]
(From yocto-docs rev: a55dc7e0f8465abf8398f51d90bbe2df7e639b3f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10348]
Added a note clarifying that -native recipes are not installed
into host paths.
(From yocto-docs rev: c0b4265350b558eec296c93f0829c3d687950c52)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10298]
Applied a small grammar fix to the description.
(From yocto-docs rev: d022a01af3f68e6e6311c47aef451e25bc8add5e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Small grammatical changes.
(From yocto-docs rev: efa1e9c3948f7dd240372a1a1c773286072fbccd)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #8631]
These fixes cover the following:
* New glossary entry for SYSROOT_DIRS
* New glossary entry for SYSROOT_DIRS_NATIVE
* New glossary entry for SYSROOT_DIRS_BLACKLIST
* New section titled "Sharing Files Between Recipes" in the
dev-manual's "Writing a New Recipe" section.
(From yocto-docs rev: e541a3c8967f51b903d9dd7978009f4fa7c2f014)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10298]
Added a better front part description to the variable.
(From yocto-docs rev: ce8a093235aa78761fde66f345f993ab7cfac6c6)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10294]
Provided text noting that if packages in the PACKAGES list are
empty are not generated, unless generation is forced through
the ALLOW_EMPTY variable.
(From yocto-docs rev: 1c89e0edf7e038f733b9b95bb884648d953b9574)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10248]
Provided more accurate descriptions for this variable and task.
(From yocto-docs rev: 422fa705165748230470fffc4fcc543ee38b1f2e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10248]
Applied some review changes. Minor wording tweaks and typo
fixes.
(From yocto-docs rev: a9e99c8b44c48c74448487187cebfe8df331e9e1)
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 #10252]
Added a note to help avoid confusion regarding the version
specification used in PREFERRED_VERSION.
(From yocto-docs rev: 38edc25b04c1a6d673ceb25f5548898d5b63b120)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
fixes [YOCTO #10248]
The bulk of this change is a new section called "Automatically
Added Runtime Dependencies". Additionally, changes were made
to the RDEPENDS and DEPENDS variables. Some cross-referencing
to the new material was also added in the do_package task entry,
the do_packagedata task entry, the PKGDATA_DIR glossary entry,
and the PRIVATE_LIBS glossary entry.
(From yocto-docs rev: 16504cd0eb23e102322c6c6096c5b52500a04640)
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>
This is the minimum requirement for YP 2.2 release.
(From yocto-docs rev: 0aebdd8556a6e5a52c0caf28dc97c1872b40e950)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9899]
This variable does not need documented in the glossary.
(From yocto-docs rev: 4082b752239025c8696bb248a20ac1fb5380c7af)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10197]
Provided better examples and a bit of a historical note.
(From yocto-docs rev: 5845aadcc4e6932abde4ce7c74834c0f2a9fb806)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9899]
I put this new variable description in.
(From yocto-docs rev: 32040277a921d0013256bed5aa7e32e14d1220ba)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10176]
Provided a more complete description of this variable.
(From yocto-docs rev: 164bf11250c965aadd1ee1573267aa31daa8a4e8)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10175]
Provided a more detailed description of this variable.
(From yocto-docs rev: 95a80313dfb276425020a61d199b75d259b47ff1)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10174]
I applied a more descriptive explanation of this varialbe.
(From yocto-docs rev: 7c6c2645b7e74e1c7de0d43b35307c8917648959)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10173]
I provided a more detailed description of how this variable
works. Also provided a cross-reference link back to the
variable at the end of the PREFERRED_VERSION variable.
(From yocto-docs rev: 679b205eea541b89e220656f7aa304d0f343c8a6)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Scott Rifenbark
Peter Kjellerstedt