Commit Graph

5208 Commits

Author SHA1 Message Date
Filip Jareš
506ec088e5 ref-manual: Fixed SRC_URI cut-and-paste error.
The update fixes a copy-paste-and-forget-to-update-everything error
in the documentation of the `SRC_URI` entry in the Reference Manual.
The `maxdate` paragraph just repeated what is there for the
neighboring `mindate` paragraph which was incorrect.

(From yocto-docs rev: fdf0a0e2e0bd0852208d08e5661a04d25c04feef)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-03-19 23:54:13 +00:00
Scott Rifenbark
9b41eae273 overview-manual, mega-manual: Updated Package Feeds diagram
The diagram had a typo in it ".ipd" rather than ".ipk".
Fixed and dropped in the figures folder for each manual.

(From yocto-docs rev: d085c285a41bacc15aa78a9f3900f4be7c45fa62)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-25 10:43:55 +00:00
Scott Rifenbark
a2e241d760 poky.ent: Updated "meta-intel" version to "10.1"
(From yocto-docs rev: 96f549eb4b047863bebadc4097fbef35a57573f7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-25 10:43:55 +00:00
Daniel Ammann
137ef19b36 ref-manual: Typo found and fixed.
(From yocto-docs rev: 035c6bc2089b19b0d0ae332bca25a75211f86964)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-25 10:43:55 +00:00
Brian Silverman
b904775c2b overview-manual: Fixed typo.
"eSDSK" -> "eSDK"

(From yocto-docs rev: 01d61e03cf004559ecccb43e8114b20823766bfa)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-12 21:48:56 +00:00
Scott Rifenbark
1b59e69854 poky.ent: Changed release month to February
Release slipped out past January

(From yocto-docs rev: 640cbaa433e94c37f4ef83088ac692fd1f5bbb2e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-12 21:48:56 +00:00
Scott Rifenbark
3d7f2555af ref-manual: Fixed INC_PR literal example indentation.
Five-space indentation missing.

(From yocto-docs rev: 6e43669a0100bb4520770d8aadee3b9c8526dbf5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-12 21:48:56 +00:00
Scott Rifenbark
8afd4cc3ec ref-manual: Updated list of supported distros.
Had to make some tweaks.

(From yocto-docs rev: 7200f3d0b75e2ffc8b755c4962b532f399b78885)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-12 21:48:56 +00:00
Scott Rifenbark
9502933d44 ref-manual: Updated the list of supported distros
Ran the script against the tip of the "thud" branch in poky
and used the supported distros returned.

(From yocto-docs rev: 75b72c440a08d38562fb846ef0714e96d4b4a811)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-12 21:48:56 +00:00
Scott Rifenbark
cc73390a75 dev-manual, brief-yoctoprojectqs: Added "2.6.1" tag to examples
Even though the tag does not exist at this point because the
release is in development, I added the tag to the list of
tags returned by the "git tag" command in the two examples
in these books.  The manual at this point is under development
so all bets are off as to things being totally accurate here.
Once the release is out, the example will work.

(From yocto-docs rev: 41e25a93eed0b75bfeb934c59a5bc4c34df53445)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-01-23 07:56:37 +00:00
Scott Rifenbark
7022689b10 brief-yoctoprojectqs, dev-manual: Update tag checkout examples
Turns out I had some hard-coded stuff in these examples.
Furthermore, I did not have good enough detail in the
brief-yoctoprojectqs manual.  I added more detail on how to get
that sato example going.

(From yocto-docs rev: 8d2fe4968eec9250c6bf9da530d2d7521f68b986)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-01-16 15:35:47 +00:00
Scott Rifenbark
a5b9706722 poky.ent: Updated release date to "January 2019"
Variable used in the manual revision tables had gone stale.

(From yocto-docs rev: 9325027bbc7bccbb9e4d4a6a02b9b2b1817f8725)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-01-16 15:35:47 +00:00
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
a3c44df7b7 poky.ent: Updated copyright variable to span into 2019.
(From yocto-docs rev: 995543e9810ba7870ba17b35bd9696af13c57e23)

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
59c4460203 dev-manual: Added note stating no WSL support
The Windows Subsystem for Linux is not supported.  Added a note
in the section on setting up the build host.

(From yocto-docs rev: e806ea6ae534608e84540ac59f972914017ccce9)

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
Scott Rifenbark
1b2dccd9b9 brief-yoctoprojectqs: Added warnings about WSL, which can't be used.
Windows Subsystem for Linux (WSL) is not compatible with the
Yocto Project.  Added information in the beginning to note this
fact to the user.

(From yocto-docs rev: 2f8f4eb5534125396fdb1958c4ef271a9ece0e7c)

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
8271ca3968 kernel-dev: Updated phrasing for what a "defconfig" file is.
It was over simplistic.

(From yocto-docs rev: 8c66db6f2a35e9e57423690976a16d6a815ccbc9)

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
e8fb450ad5 dev-manual: Updated the "Post-Installation Scripts" section.
Added a better, more up-to-date description of the way to defer
a post-installation script past the boot.

(From yocto-docs rev: 722b1b9c5bee1d43c45d943624854a53adc07939)

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
494ba9bf74 dev-manual: Removed occurrence of mkefidisk.sh script.
Script has been removed.

(From yocto-docs rev: e1db4da1f7de8b9aa6e1ffffe71cdcf4929e5821)

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
9cedaa6740 poky.ent: Updated release month to November 2018 (thud)
(From yocto-docs rev: 8f7b74097e29b4dc8fea5b999b54a0a92896d9e3)

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