This is the completed first draft.
(From yocto-docs rev: 45d39b7655ea5b515c8dda91249a84ee19387099)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The KERNEL_ARTIFACT_NAME variable is used throughout to set the names
of build artifacts. Rather than repeat informaiton about
KERNEL_ARTIFACT_NAME in the many variables that use it, I added
a new entry for the variable. This also impacted the descriptions
of the variables that were repeating information. I updated those
variable descriptions as well.
(From yocto-docs rev: 5750d30be21e17fe21d89254925dc0e773c08e66)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I changed the wording "post 2.6" to state "2.6 and
forward". It was incorrect as the changes are inclusive
of YP release 2.6.
(From yocto-docs rev: fb3f3db17ea416cd829a291df3933cc3597392b8)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The KERNEL_IMAGE_NAME variable is new and is effectively
a renamed KERNEL_IMAGE_BASE_NAME variable now. I provided a
new glossary description for the new variable. I updated the
existing KERNEL_IMAGE_BASE_NAME description to note it has
changed. We can't just delete the old variable as there are
migration notes for previous releases of YP.
(From yocto-docs rev: e5a38711342f88ded4368521a70e9d117b6d991c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Made two minor corrections from reviewer feedback.
(From yocto-docs rev: 765e44127f52e1d9d4d1c365b0574ca73364add2)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Provided more explanation and also a link into the BB manual
for a detailed example.
(From yocto-docs rev: ca1e113dc837f5104f765b655880a87d1fbd66ac)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Provided some new sections on the information for migrating from the
2.5 release to the 2.6 release.
(From yocto-docs rev: dd721a31594c753d7229c45ebad0ce11640a0704)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added notes indicating that the best practice for automated testing
is to inherit these classes by using the IMAGE_CLASSES variable instead
of the INHERIT variable.
(From yocto-docs rev: 8f4765db897c20f0011ea65f62d6b45495d313d2)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The TEST_IMAGE variable went away and was replaced with the
TESTIMAGE_AUTO variable. Fixed all related/affected areas.
(From yocto-docs rev: 660da40b4fcdc05666e1877037fa63eb1dfe7227)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12390]
Updated three variables: BB_ALLOWED_NETWORKS, BBMASK, and BBFILES.
Fixed some linking to be sure to use Python3 links instead of
Python 2. Fixed a note to clarify use of the "*" wildcard
restrictions in the BB_ALLOWED_NETWORKS variable.
(From yocto-docs rev: 6f880d10d0830d80cc2d4d1d5b7ea141dad6d4af)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11107]
Updated the SSTATE_MIRRORS variable description to include
explanation of how to use regular expressions to map file locations
to server-provided URLs to share sstate information.
(From yocto-docs rev: 1357095864ee919f576de8df36f4e177b24fdd22)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added specific wildcarding support descriptions for all related
variables and file panthnames.
(From yocto-docs rev: 543e398c4ae1bce38517a88cd91c957a583a2892)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12924]
Naming convention does not apply to the second recipe-creation
method described in this class. I have moved the note about that
to be under the applicable method (i.e. the first bullet).
Fixed the syntax reversal of the sample name in the example.
(From yocto-docs rev: f7f1a89043156527fa4b426c0322ad225a9f2ff1)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added the "debug-with-srcpkg" option for the PACKAGE_DEBUG_SPLIT_STYLE
variable.
(From yocto-docs rev: 05c51e53059bf7c999a448402d60d0b16d62341b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added "baremetal" as an argument.
(From yocto-docs rev: 34cb39334d0af43f3c184adbfc53270def394154)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed the section heading in the dev-manual for building images for
multiple targets useing multiple configurations. This wording is
more accurate. I updated the link from the BBMULTI_CONFIG variable
description as well.
(From yocto-docs rev: 3b2f95c3c54bed7ab8b4673ba7a254d31bea811b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section on the siteinfo.bbclass file had a paragraph indicating
base.bbclass included siteinfo.class. This is not true since
2010. I removed the paragraph.
(From yocto-docs rev: 5d39220baddc9db5c1182cea8447e5c4a2e42bd8)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The documentation of available names for TEST_TARGET has been
updated to match the convention of using the class names of
controllers.
This commit was modified some to make it work. Fixed some
formatting errors and isolated and changed missed instances.
(From yocto-docs rev: 1bec1dc38cdd1746ce6dd539f9c3e5665d12ab8e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The title needs to use the terminology "Build Host" to be consistent
with the manual set. I updated the title and the many links into that
section.
(From yocto-docs rev: 930030433e58e6180ee4f95e559d079c3899defc)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Took out an occurrence of PACKAGE_WRITE_DEPENDS
(From yocto-docs rev: f7b2c7c08f3f504e14943a01e7fc0a73c96e9636)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Provided more detail and a cross-reference into the SDK manual
where you can change the title through the variable.
(From yocto-docs rev: 9617fa70caef48328455a02d5260e536fac19c53)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This variable is the default installation directory for the
Extensible SDK. By default, it is "poky_sdk". You can override
this variable so it needed to be documented. The ideal place to
override it is in the distribution configuration file.
(From yocto-docs rev: 67eca50fa973073ce6e7975ab66b89b9706c25c0)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I provided some real detail on this variable. It was woefully brief.
(From yocto-docs rev: 4282fabddc81bf4c0fbd0a641ec4f1e9754660c2)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added a cross-reference to the "DISTRO_NAME" variable as it is
the long version of the distribution name.
(From yocto-docs rev: bb5638409faadb9c6a5fbca729e4e6b8a220433d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Wording did not match that of similar SDK variables.
(From yocto-docs rev: 696eb9ff0b89222dc696adc0bd28247c0a0c731a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Put in a cross-reference to the section in the sdk-manual where it
talks about customizing the configuration of the extensible SDK.
(From yocto-docs rev: 062db19dd56cc1827ebd7614eb8a54660421df62)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added information on the class in which the default is set. Also,
put in a reference for more information on customizing the
extensible SDK configuration.
(From yocto-docs rev: a0145996aeac1bb45fea9f613789b00327f92d1e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Enhanced this description by indicating the class that it is set in
and by including a pointer back into the sdk-manual where filters
are described for extending the extensible SDK.
(From yocto-docs rev: 355b05366aadc337ec3337c0a3c918a23027923b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added more detail including the class that sets the default variables
for exclusion and the list of actual variables that are excluded by
default.
(From yocto-docs rev: f24287851998d554575c6aaf9dcc50d198931e48)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
FIXES [YOCTO #12734]
Added a new variable description and created a new
section in the dev-manual.
(From yocto-docs rev: 854e641482171585c96ee5b9387b3e64146072b9)
Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Renamed to "Speeding Up a Build" and moved out of the setting up
chapter to the common tasks chapter. Fixed a couple links in the
ref-manual.
(From yocto-docs rev: c53fddd353230c8ef1abc21c7a2d2b1f492f034a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed to "Locating Yocto Project Source Files". I am moving the
sections on cloning repositories out from under this section.
(From yocto-docs rev: 3889aadab9b603097b6cc5b7afb9d0066021106c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section on licensing in the overview-manual was really "how-to"
information. I moved this to a new section in the dev-manual for
"working with licenses". I fixed some references in the ref-manual and
in the bsp-guide as well.
(From yocto-docs rev: f150a1ea2da900aae88fc5fa60f4115cc213ba2d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The Wayland and Weston topic moved from the overview-manual to the
dev-manual. The lone link to this topic was in the ref-images
chapter. I updated the link.
(From yocto-docs rev: 6c335f8d3618e3285f91fe20aea33a1c1f1c0ddf)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Now that 2.5 has released, I replaced the ENTITY variable used for
the moving month and year with the actual release month and year
(i.e. May 2018).
(From yocto-docs rev: 2d6e8ddce4fce0c405d2aea69cea2a5b262410f7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added more realistic information on how this variable is set.
(From yocto-docs rev: 47e6cb7d00eeb8001c4a53c13600feb5ef4d4660)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The note about the TAR backend not working was changed to soften
the warning. It has "limited functionality" rather than
"broken".
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This variable plays a much smaller role since recipe-specific
sysroots were implemented. I have rewritten the description to say
that STAGING_DIR helps construct the recipe-sysroots directory.
(From yocto-docs rev: c1ad18abe67111738efc18725c4f7706b55738cb)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a reference to the STAGING_DIR_HOST variable, which is part of the
default directory used as the shared, global-state directory holding
data generated during the packaging process.
(From yocto-docs rev: d68dcec327e96f1da0879681dcde43d4f1769af0)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Re-oredered the four options to be alphabetical.
(From yocto-docs rev: 7976ee05c935fd6c24abea99f71436003656cc73)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added some key references to the patching areas of discussion across
the manual set.
(From yocto-docs rev: f198529b3072a4a03fd368ea307e8e004c46a344)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The file:// protocol is primarily used for digging out patch files that
are local with the metadata (layer). I put a link in the paragraph that
is talking about them to the "Patching" section in the overview-manual.
(From yocto-docs rev: 18a7b4b81d192fb2cfd96763de4cfabd61c3a0ea)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Mentioned the role of SRC_URI earlier in the description as it is key.
Replaced "some_recipe" with "some_package" as the emphisis is not on
the recipe at that point in the example.
(From yocto-docs rev: f7f86941fdf866a693386335374f835078db3ddf)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added more content to this task description to help describe how
patching is performed and how the task uses the "apply" parameter
that can be provided with the SRC_URI variable.
(From yocto-docs rev: 6717a3326b0005f6a57be4cc026693b7cd9e8d08)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a new feature (task) to the list of available features you
can use with the variable. The "task" feature saves output file
signatures for sstate tasks.
(From yocto-docs rev: 0669580ce40c46f0b5f8204a6b00e11f725a383c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Provided a more complete and clear description.
(From yocto-docs rev: 65505debfb82536e7e2d4ff7e5bc14c6af1a7cf6)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added a link to the BUILD_ARCH variable. The variable is part
of the glossary but for some reason there was no link to it.
I also added a note for a link to the SDK_ARCH variable, which
was described inline. By convention, I do not like to link to
variables inline as the underlining used to indicate a link messes
with with underscore characters that are usually a part of a
varible's name.
(From yocto-docs rev: a2f487141375ee7ce226eece85424e709ddc67a3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The method for accessing the YP Release Notes for YP 2.5 forward
is to go to the "DOWNLOADS" page of the main YP website and then
click on the "RELEASE INFORMATION" button. No longer does a user
need a simple URL. I updated the two spots in manual where this
information existed for accessing Release Notes.
(From yocto-docs rev: 1e171d3add1048fb81c5a05a11c8ddbaf88e0ecd)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Provided a link to the YP implementation of Bugzilla. Added a final
paragraph noting the Bugzilla website if you want general information
on Bugzilla.
(From yocto-docs rev: 78c99c8f42edfee377431cacc10b9ccd4b25c4cf)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Link was not going to the top of the chapter.
(From yocto-docs rev: 52da20604a54d16645b4bb4e5e9efa748a00d2f5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed redundant link to CFLAGS in the TARGET_CFLAGS variable
description.
Removed redundant link to CPPFLAGS in the TARGET_CPPFLAGS
variable description.
(From yocto-docs rev: aa95485d44f92b831cd111dbc5bf75526d239db4)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The wording to two links (one a variable and one a section in a
different manual) was ambiguous. I added phrasing to remove that
issue.
(From yocto-docs rev: 3b70b4287ca8b2583e0ef559125f1531a2bb6a67)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed the link to WORKDIR to begin with. Also, removed the
<filename> formatting that was within the example, which is buried
in a <literallayout> tag set. Doing that screws up the formatting.
(From yocto-docs rev: 0d13dabaa13e5426da35b5d8147f51efa349b5bb)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added "class" as a modifier after refering to the "populate_sdk_base"
class.
Removed link to the TMPDIR variable in an in-line example.
(From yocto-docs rev: 7733a4464ba2893a2363f47996f48587a86eaa82)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Several redundant links and wordings in this description.
(From yocto-docs rev: bb9dd8ab6ef9cad387cdddada4f2be093551e38a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A migration item had taken the original section for the target of
the link out. I had not changed it.
(From yocto-docs rev: 10cfaee50455bf10450540f1b381d33f9babf985)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Two instances where links were going into the kernel-dev manual
but the manual title was not being used in the text. Added it.
(From yocto-docs rev: 1922f8c79d1667db1fc9b5fe57030302469ca09c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The link was to a chapter in the existing manual. I do not
include the manual title when that is the case.
(From yocto-docs rev: 1b7c65b4a2dde3f5d069cb5edc75728492639870)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Link was going to TARGET_PREFIX.
(From yocto-docs rev: 424e8ea3168ab2e910919e6f70fc0b16332ca4f7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
