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 #8596]
Added a new section to describe the right way to use headers to
interface to a device or custom Linux kernel API. Too often a
user wants to modify the libc header file, which absolutely wrong.
This new section provides some guidance.
(From yocto-docs rev: 960c49bf6446398a9efb2d018d09d63b49e97196)
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 #10887]
I placed a small paragraph at the end of the introduction to the
"Performing Automated Runtime Testing" section that points into the
new section on QA and testing infrastructure in the ref-manual.
(From yocto-docs rev: 493051e1770e07b89c19a1f235f1dd226610c77a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10596]
No information existed for the version 1.0 YP Compatibility Program
for layers. Additionally, the version 2.0 flavor is adding a script
as part of the application process. I put in a new section on the
whole topic. Also, integrated the information into relevant sections
with some cross-referencing.
(From yocto-docs rev: 6341705d4c08901b2657c489f4e995968db00d85)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9675]
I missed one occurrence of changing "smart" to "dnf" in the
Enabling Tests section. Corrected.
(From yocto-docs rev: b5106c7a38f51dbfea6d200072039f624be7ed3a)
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 section in the dev-manual that introduces BSP Layers for the
first time was missing a general link to reference into the BSP
Guide to help the user understand BSP Layer structure. I added
a note.
(From yocto-docs rev: c515e30a551e96e11091c3850f7eed1b034abdad)
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 #11048]
No documentation existed for telling the user how to create signed
RPM packages or for how to use signed package feeds. I have created
a new section on the topic to describe both scenarios.
(From yocto-docs rev: cbdde75f06b1fc190b8e4f7f93f302dc238e3e7f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section "Maintaining Open Source License Compliance During
Your Product's Lifecycle" had a vew minor typo things (e.g. duplicated
word and some formatting issues). I fixed these.
(From yocto-docs rev: 67beb658445e79129d8aae1739bb33c000367107)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10621]
bmaptool is integrated into the OpenEmbedded build system but is
not documented. I added a new section describing how to flash an
image to media using the tool. Also, updated a small section in the
Wic part of the manual that used "dd" to flash an example. I added
a bmaptool counterpart here and referenced the reader back to the
main new section.
(From yocto-docs rev: 98ebe9acccceea2b833c1372a3e664befd1b6aef)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10621]
bmaptool is integrated into the OpenEmbedded build system but is
not documented. I added a new section describing how to flash an
image to media using the tool. Also, updated a small section in the
Wic part of the manual that used "dd" to flash an example. I added
a bmaptool counterpart here and referenced the reader back to the
main new section.
(From yocto-docs rev: 83a9a3aa5f20c7f389306eea9213eabea997aba1)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7096]
Applied a couple review comments to the section to clarify where
to set key variables. Also fixed an incorrect variable name used
to specify the *.cpio file.
(From yocto-docs rev: 24861b36804cbd636aafc36b1918bcfe33ca3811)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10763]
The final example in the section describing how to create
the base recipe using receipetool create was wrong. I updated
it to use the -d option in addition to the -o opetion. I also
changed the description to match appropriately.
(From yocto-docs rev: 8cc6d5e21532eeaac0e6d9ace3e0b58803a9804e)
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>
new information on how wic works
(From yocto-docs rev: 7b6a54a593a678442541b1fa6847498a792183c7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10351]
I added a note to the "Post Installation Scripts" section of the
"Writing a New Recipe" section to call out the fact that the
RPM package manager will not install packages on the target when
any RPM post-install script returns a non-zero exit code when
the script is run on the target.
(From yocto-docs rev: 8565b0ba874f3357500a91640c0f77077c83b8d6)
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>
The string appeared in the text as "$(INC_PR).0". So, fixed
it to be proper with the curly braces.
(From yocto-docs rev: 0e4ca6cd3d0eae847243fc624c5f119d004cf40c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed [YOCTO #10588]
This section was confusing due to the fact that it used an actual
set of IP addresses and image name where they should be clearly
called out as examples. Fixed it.
(From yocto-docs rev: 4682899c7b70c730256412bf08f469c457af1c2e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added a new section in the "Common Tasks" chapter to support
the fact that BB can now build for multi-configurations.
(From yocto-docs rev: aa21aeb2f3d2f9d5a3a6e7175b7c6f13da5f608e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed [YOCTO #9481]
Complete re-write based on Mark Hatle's steps. I converted
from sub-sections to an ordered list.
(From yocto-docs rev: f83bfe5d3dc012b924b6870672d7260a9c0bc3ee)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10392]
Moved the last bullet item from the list that was about
DEPENDS to a note form above the list. This was done because
the stuff for DEPENDS is more general.
(From yocto-docs rev: 2879d97b14322f1f9495288fc7f2298a186c5f68)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10392]
People often needlessly put [noexec] on tasks, making the recipes
more complicated than they need to be. I updated the first bullet
item in this section to more clearly explain how to do this.
Also, added a new bullet item to the end to point into the DEPENDS
variable for more clarification.
(From yocto-docs rev: c61e61c1a5f9524c50bfc26335ea6c2027cafd19)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10360]
Added a new section to reference into the OpenEmbedded Styleguide.
This will help people writing new recipes to conform to known
styles.
(From yocto-docs rev: 40c12742c78f5aba5bb4e43f759e8c478470fd83)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9554]
In the examples, I changes "IMAGE_FEATURE" to "IMAGE_FEATURES_append"
(From yocto-docs rev: 3fc2cc217a0a67b3e0739c6a235ab8e350c4b7c3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO 10323]
Made a code change to the example script that helps a user
locate GPL files.
(From yocto-docs rev: bd02012de75f0c30887d3a5bb4aa219703a3ee1c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10323]
In the Providing the Source Code section, I replaced the 3-line
code example that returns GPL files. The bits I put in are a
script that does the trick. The 3-line example was not working.
(From yocto-docs rev: a07873d46b5135555961499c6ce8f0b6b8bf2c8f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9554]
I applied some review comments for the section on using GDB
on the target for debugging. Included a new note on optimizations
considerations.
(From yocto-docs rev: 23f0dd82f682ea39849de0f589ee1ebfb16be749)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9554]
I added a new section titled "Debugging with the GNU Project
Debugger (GDB) on the Target" that provides requirements for
this type of debugging.
(From yocto-docs rev: 5d15c6c5f2030395f9faea8a5ef3ead1b98042d8)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9285]
Altered the wording to more accurately reflect the issue.
(From yocto-docs rev: 66cda9997a6c17752903a0b5600fb8cae98566e9)
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 #9679]
I added a new section titled "Dependencies" inside the section
that talks about writing a new recipe. This section details
both build-time and runtime dependency behavior and conditions.
(From yocto-docs rev: 37305ea09473dcaee2db4f9cc37c7ce0fc33c52a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied various edits to the "Writing a New Recipe" section.
Several nits.
(From yocto-docs rev: 17818ff89805e0df3a0445f64a4f9133550fa7d0)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Made several improvements to this section.
* fixed a typo where a YP release was referred to as 7.1
instead of 1.7
* Added a note box to the "Using Variables" list item
elaborating on the expansion behavior.
* Removed the detail around the WORKDIR discussion.
* In the "Loccate or Automatically Create a Base Recipe",
I added the devtool add method to the list of ways to
create a base recipe.
(From yocto-docs rev: 79c86fc3653c747ae42f08528063a8984cdd3b4d)
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 #9285]
Applied some rewording to the last bullet of the "Known
Issues" section in the "Enabling GObject Introspection
Support" section.
(From yocto-docs rev: 6cc0c7925984a29a115819195b800e2ecd8b4757)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9707]
* Replaced gummiboot with systemd-boot in the dev-manual
* Replaced the gummiboot class with a new systemd-boot class
* Replaced the appropriate gummiboot variables in the glossary
with new variables SYSTEMD_BOOT_CFG, SYSTEMD_BOOT_ENTRIES,
and SYSTEMD_BOOT_TIMEOUT.
(From yocto-docs rev: 778b620e65cc68531b3c41aeb8f27f2a07eb0d00)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10135]
Some small problems were fixed:
* Added a cross-reference in the FILES glossary entry to the
PACKAGES variable. The two are tied and there was not a
reference to it.
* Removed a redundant "/" character in a pathname example in
the dev-manual.
* Removed a redundant "/" character in an example pathname
in the FILES glossary description.
(From yocto-docs rev: 11a397c232696deece7ac5c6dafcadb87d7a5775)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9285]
Added a new bullet item to note that Using QEMU in usermode
might not work properly when running 64-bit binaries under
32-bit host machines. In particular, "qemumips64" is known
to not work under i686.
(From yocto-docs rev: 896beb3fddd427f8327d4ddd35be253866c90377)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9672]
A couple typos here needed fixed. Also, a missing statement in
the JSON example.
(From yocto-docs rev: 8756cb363a70a8b77077a666c62c0f678ffb3d3e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Scott Rifenbark
Martin Vuille