Commit Graph

1896 Commits

Author SHA1 Message Date
Scott Rifenbark
004ec4fb4d Documentation: Prepare for 2.6.1 release.
Updated the following:

 * poky.ent to use new variables values for 2.6.1
 * mega-manual.sed to use "2.6.1" string for links
 * *.xml manual files to have a new entry in the manual history
   tables.  Using the variable for the most recent entry.
   Hard-coded "November 2018" for the previous release, which
   was "2.6".

(From yocto-docs rev: bada424e14169d1ae378c0481970e55ce8f5df51)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:54:55 +00:00
Peter Kjellerstedt
8349383002 ref-manual: Document the fifth argument to PACKAGECONFIG
(From yocto-docs rev: 1a4a95d070d79bfeb202faf381c2e0a288ba88f5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:54:55 +00:00
Peter Kjellerstedt
af4b3c6f9b ref-manual: Add missing whitespace around "=" in a few code examples.
(From yocto-docs rev: 0ed3bd9cfe6a3ad04e2ebbbcc95320275dcfacad)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:54:55 +00:00
Scott Rifenbark
dbc9755027 ref-manual: Updates to CMake and cmake.bbclass.
I cleaned up the terminology used for the CMake build system.
I provided some meaningful links to a good overview page for CMake.
I also built in some cross-referencing as needed.

(From yocto-docs rev: 7e825427a2dcef2b91a1bfbf1827b73e034e0974)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:54:55 +00:00
Armin Kuster
d99d261613 ref-manual: Updated list of supported Linux Distros:
Updates for the "thud" release.

(From yocto-docs rev: 1e8dd2130c7814895cf745b615346d3715d39fac)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:54:55 +00:00
Scott Rifenbark
582f0ca361 ref-manual: Added a note saying WSL is not supported.
Windows Subsystem for Linux (WSL) is not supported with the
Yocto Project.

(From yocto-docs rev: 68dea2908b5cfeb9e374c6e72493f6b635267dda)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:54:55 +00:00
Ming Liu
94a6cd1c2f ref-manual: Updated image_types.bbclass description.
The "image_types" class is now inherited mandatorily in
image.bbclass through the variable IMGCLASSES.  Users do not
have to inherit it in their customized image type bbclass.
They also do not have to put it in IMAGE_CLASSES.

(From yocto-docs rev: 9d71cd281864478c76e40fa6e0b9cd0055f131c0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:54:54 +00:00
Scott Rifenbark
95b373b7eb ref-manual: Added description for devupstream.bbclass
New section added.

Fixes [YOCTO #12732]

(From yocto-docs rev: e0c4006614cca76f07782c8273f4c8cba5394220)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:54:54 +00:00
Scott Rifenbark
7ded3cc8cc ref-manual: Added cross-references to "Post-Installation Scripts"
Two areas in the migration chapter discuss the post-installation
behavior when you defer the scripts to after boot.  I added a
couple references to each of those migration note sections that
go into the dev-manual's section.

(From yocto-docs rev: fd550364c6fcfdff24b5c69f289733ed319c6be1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:54:54 +00:00
Scott Rifenbark
4623ec19ac ref-manual: Updated "Packaging Changes" section for 2.6 migration.
Changed reference to "python-modules" to "python-modules /
python3-modules".

(From yocto-docs rev: d3efb499d0f027be5233dc2f922cef98b03015ca)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:54:54 +00:00
Scott Rifenbark
274946ead7 ref-manual: Applied review edits to the 2.6 migration section.
Minor fixes here and there.

(From yocto-docs rev: 37617222d5e76cd9debfb8271807ff016d124010)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:54:54 +00:00
Scott Rifenbark
2559ad01c3 ref-manual: New 2.6 Migration section complete.
(From yocto-docs rev: 6d898834bbcef29934f9fcf895880acdb8838a57)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:54:54 +00:00
Scott Rifenbark
7d0a2ece0b ref-manual: Added new python3 profile-optimization migration topic
(From yocto-docs rev: 108adb60eabf43ddd4fa91f26b701e7a2930dcee)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:54:54 +00:00
Scott Rifenbark
44d52d9c72 ref-manual: Updated postinstall migration note.
(From yocto-docs rev: beb7286abdfa2a6f9cc1772429671250a52d6425)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:54:54 +00:00
Scott Rifenbark
339d7d2bd6 ref-manual: Updates to the 2.6 migration section.
This is the completed first draft.

(From yocto-docs rev: f7f7e6b64c3dc8380b107851abc5719fd806683a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:54:54 +00:00
Scott Rifenbark
7ef287ae21 ref-manual: Added KERNEL_ARTIFACT_NAME and adjusted referencing variables.
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: e3fd82b1c65460097d7e0f2398be8c8756892e65)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:54:54 +00:00
Scott Rifenbark
e886536f1b ref-manual: Removed the NOISO and NOHDD references.
(From yocto-docs rev: ae83daebbb316d2c34136c466bdf7b491c9fff1b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:54:54 +00:00
Scott Rifenbark
b57a73f9c3 ref-manual: Removed the NOISO and NOHDD variables.
(From yocto-docs rev: 969533a299c559eadeb8807e94f6af79fbf8f66a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:54:54 +00:00
Scott Rifenbark
2aabfcb46d ref-manual: Added several new sections to the 2.6 migration section.
(From yocto-docs rev: 0f5d18d0118632db43706beef7d2020ec6890ade)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:54:54 +00:00
Scott Rifenbark
667f70276d ref-manual: Added new artifact naming variables to glossary.
(From yocto-docs rev: 8c4d8fba8e5bf84a230c112b1b46a3bc5453184a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:54:54 +00:00
Scott Rifenbark
356355d1a7 ref-manual: Changed "post 2.6" to correct wording.
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: 93720a1c072ad6268cb5681c51660f03059d880a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:54:54 +00:00
Scott Rifenbark
8b9e5b95e5 ref-manual: Added KERNEL_IMAGE_NAME description
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: 2a7bc2dd274f23d58c997771175c37005763ed08)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:54:54 +00:00
Scott Rifenbark
d6725d934d ref-manual: Added GCCVERSION variable description to glossary.
(From yocto-docs rev: f48ffe39e2d0c1bc57579e4ee457c72b7c626ad1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:54:54 +00:00
Scott Rifenbark
425b42f720 ref-manual: Updated migration section for 2.6
Made two minor corrections from reviewer feedback.

(From yocto-docs rev: 41e657ba47dd91a10a1d1ae4855e959eb697ea76)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:54:54 +00:00
Scott Rifenbark
f34e49fa2f ref-manual: Updated 2.6 migration topic "_remove"
Provided more explanation and also a link into the BB manual
for a detailed example.

(From yocto-docs rev: eb2a3bc65c99ae72173d5f3848af423af112ccb2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:54:54 +00:00
Scott Rifenbark
d0884492a8 ref-manual: Added the 2.6 Migration Section.
Provided some new sections on the information for migrating from the
2.5 release to the 2.6 release.

(From yocto-docs rev: b95183e9f2358ec5bc67081334e13526ba1ad48d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:54:54 +00:00
Scott Rifenbark
c5ba99bc06 ref-manual: Updated testimage and testsdk class descriptions.
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: 70e18e93e96f283ae183f5f4468859bfca37c581)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:54:54 +00:00
Scott Rifenbark
400d491e8d ref-manual, dev-manual: Removed TEST_IMAGE for TESTIMAGE_AUTO.
The TEST_IMAGE variable went away and was replaced with the
TESTIMAGE_AUTO variable.  Fixed all related/affected areas.

(From yocto-docs rev: 84e2c149fa823ab6e12be17b049c9bae1c1dd904)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:54:54 +00:00
Scott Rifenbark
21e5d8e2c6 ref-manual: Updates to variable wildcard support
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>
2018-10-29 16:55:19 +00:00
Scott Rifenbark
bd6d8db54b ref-manual: Updates to the SSTATE_MIRRORS variable.
Accounting for uninative stuff.

(From yocto-docs rev: 5915f1345e3b91ae848cf419560d8fae4e850058)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-10-29 16:55:19 +00:00
Scott Rifenbark
21c7646779 ref-manual: Updated SSTATE_MIRRORS variable description
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>
2018-10-29 16:55:19 +00:00
Scott Rifenbark
4b4b9c9c19 ref-manual: Updates to describe wildcarding support
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>
2018-10-20 14:28:00 +01:00
Scott Rifenbark
6d9de01c18 ref-manual: Updates to native.bbclass
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>
2018-10-04 14:33:50 +01:00
Joshua Watt
1b18eaa376 ref-manual: Added "debug-with-srcpkg" option to package split variable
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>
2018-10-04 14:33:50 +01:00
Scott Rifenbark
83270f0722 ref-manual: Updated TCLIBC variable.
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>
2018-09-11 09:36:07 +01:00
Scott Rifenbark
48b17b2bfe dev-manual, ref-manual: Changed section heading for multiconfig builds
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>
2018-08-28 10:30:43 +01:00
Yevgeny Popovych
e0e333b485 ref-manual: Removed misleading paragraph in siteinfo.bbclass
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>
2018-08-15 10:28:44 +01:00
Paulo Neves
c610d310e7 dev-manual, ref-manual: Updated available names for TEST_TARGET
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>
2018-08-15 10:28:44 +01:00
Scott Rifenbark
324d3ad00a documentation: Changed section title for required packages.
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>
2018-08-15 10:28:43 +01:00
Scott Rifenbark
3e3f6d55b1 ref-manual: UPdates to the PNBLACKLIST variable description
(From yocto-docs rev: c8a606dbce01132e95250c33270ff729cadc2c0e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:43 +01:00
Scott Rifenbark
601e84c204 ref-manual: Removed non-existant variable from PACKAGE_WRITE_DEPS description
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>
2018-08-15 10:28:43 +01:00
Scott Rifenbark
9fc6304bf8 ref-manual: Updated the SDK_TITLE variable description
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>
2018-08-15 10:28:43 +01:00
Scott Rifenbark
0efdd1d4da ref-manual: Added SDKEXTPATH variable description.
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>
2018-08-15 10:28:43 +01:00
Scott Rifenbark
895feaac61 ref-manual: Updated DISTRO_NAME variable description.
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>
2018-08-15 10:28:43 +01:00
Scott Rifenbark
91c70cf4a0 ref-manual: Updated the DISTRO variable description
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>
2018-08-15 10:28:43 +01:00
Scott Rifenbark
eabfa9f398 ref-manual: Fixed cross-reference wording in SDK_LOCAL_CONF_WHITELIST
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>
2018-08-15 10:28:42 +01:00
Scott Rifenbark
f0fe442143 ref-manual: Fixed grammar error in SDK_INHERIT_BLACKLIST description
(From yocto-docs rev: 0a5775f7ad3e0b6531fcfd1d328d8e0da8727400)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:42 +01:00
Scott Rifenbark
4d1feb55fa ref-manual: Added cross-reference to SDK_LOCAL_CONF_BLACKLIST var
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>
2018-08-15 10:28:42 +01:00
Scott Rifenbark
701e9c3fe5 ref-manual: Updated the SDK_INHERIT_BLACKLIST variable description
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>
2018-08-15 10:28:42 +01:00
Scott Rifenbark
e9fd884751 ref-manual: Updated the SDK_LOCAL_CONF_WHITELIST variable description
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>
2018-08-15 10:28:42 +01:00