Commit Graph

5365 Commits

Author SHA1 Message Date
Scott Rifenbark
afe2d7cf45 dev-manual: Updated "Enabling Runtime Tests on QEMU"
Fixes [YOCTO #12517]

Added some qualifying information for how to generate a list of tap
devices to enable runtime tests on QEMU.

(From yocto-docs rev: 4359a355944f6cf4ec1e14ecbedc690ef37ff743)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:34 +01:00
Scott Rifenbark
88c6050ad2 overview-manual, dev-manual: Moved Wayland and Weston
The Wayland and Weston topic moved from the overview-manual to
the dev-manual.  The topic was really a "how-to" topic and not
a concepts topic.

(From yocto-docs rev: b0f20a67c99590c48d595f4e572339bb5b6b83b3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:34 +01:00
Scott Rifenbark
c72b126bc0 ref-manual: Chanaged a link to Wayland topic.
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>
2018-05-24 17:16:34 +01:00
Kristi Rifenbark
6da15e51a8 ref-manual: Formatting pass of 2.5 Migration section
(From yocto-docs rev: 50308cc7f04d3fc54c06766f85e15e76a99f0b4b)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:34 +01:00
Scott Rifenbark
3564ddf02c overview-manual, dev-manual: Moved sstate debug tips sections
Two sections at the end of the shared state concepts section
in the overview-manual are really task sections.  I took those
and created a couple new sections in the dev-manual to house
those topics.

(From yocto-docs rev: 86382e7873d796f44554c8e04d3bd8091d350f51)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:34 +01:00
Scott Rifenbark
dbdc897ca9 overview-manual: Updated "Invalidating Shared State" section
Removed "OpenEmbedded" in the string "OpenEmbedded build system."

(From yocto-docs rev: d44b370b0fb993c32c9dfe3515188fa9e7ff2437)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:34 +01:00
Scott Rifenbark
fd7f63eb57 overview-manual: Updated "Shared State" section.
Added the line with "stamp-extra-info" flag to the example from
the deploy.bbclass.  This line was missing or it had been added
since the original writing of this section.

(From yocto-docs rev: 50f5482c2132235962d4ab48d0d7263628df1728)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:33 +01:00
Scott Rifenbark
ad44dc9b7c overview-manual: Updated "Cross-Development Toolchain Generation"
I made some small edits to this section.

(From yocto-docs rev: a2cc355c1bdfbf10f86f8d4994cc81dfb12d8f87)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:33 +01:00
Scott Rifenbark
50c83e8b70 documentation: Removed release date ENTITY
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>
2018-05-24 17:16:33 +01:00
Kristi Rifenbark
8d751c065d ref-manual: Added 2.5 Migration Section
(From yocto-docs rev: 5d6c1b69e5559eced5142f46421302f61c95404c)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:33 +01:00
Scott Rifenbark
d96c451901 ref-manual: Updated the SDK_OUTPUT variable
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>
2018-05-24 17:16:33 +01:00
Scott Rifenbark
63d56741ed ref-manual: Updated SDK_HOST_MANIFEST variable.
Grammar fix.

(From yocto-docs rev: aa5a60c8e3bf3f243678169b323e7ea5df7a6c19)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:33 +01:00
Scott Rifenbark
cb244d438a overview-manual: Minor edits to the SDK generation section.
Added the descriptions for the SDK_HOST_MANIFEST and
SDK_TARGET_MANIFEST variables.

(From yocto-docs rev: 212d6c5b3290016431604e67dfb27a1408ac0463)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:33 +01:00
Scott Rifenbark
99c4743469 overview-manual, mega-manual: Updated the sdk figure
Added the manifest files to the figure and the associated variables.
Also added the test files.

(From yocto-docs rev: cfba55462d1c37ef2ff6454890da64a40f9c3607)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:33 +01:00
Scott Rifenbark
2eee77ccf4 overview-manual: Minor wording changes to the "Images" section.
(From yocto-docs rev: a3e825e6086ec7674641658cc956020e3e1cd9dd)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:33 +01:00
Scott Rifenbark
a934764b97 overview-manual, mega-manual: Updated the Images figure
I needed to add some italic formatting for variable type strings.

(From yocto-docs rev: afc6d2d10081f9e9d940075c03b3e704b37cf13b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:33 +01:00
Scott Rifenbark
b20454dbdf overview-manual: Updates to the "Images" section.
Some minor rewrites.

(From yocto-docs rev: 71cbc1c389389ffac9e59faacdc56d3ea05facd7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:32 +01:00
Scott Rifenbark
6f90c96872 overview-manual: Updates to "Setscene Tasks and Shared State"
Updated with a few minor wording changes.  Tried to get a little
more active from some of the passive wording.

(From yocto-docs rev: 7dcd8117e3ea40d4b3c1ee5c3b1ea3c2bd29893a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:32 +01:00
Scott Rifenbark
4cd96b295e ref-manual: Updated PACKAGE_CLASSES variable note.
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>
2018-05-24 17:16:32 +01:00
Scott Rifenbark
bd3df79121 overview-manual: Updated text for Image and SDK generation.
General improvements to both sections.

(From yocto-docs rev: 977fdeaf1258613c3dfc41d78c8125fdba9b2a24)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:32 +01:00
Scott Rifenbark
1211c01f82 overview-manual, mega-manual: Updated image generation image
The figure for image generation of the BitBake process
needed some enhancing.

(From yocto-docs rev: fc978663a7962d1515d4f47abe8ae522b9e24ce1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:32 +01:00
Scott Rifenbark
a35bdbeb06 overview-manual, mega-manual: Updated SDK generation image
The image needed a little bit of clean up.

(From yocto-docs rev: d4fb680be194b7f9b192e06f0081a09504649633)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:32 +01:00
Scott Rifenbark
173f158121 overview-manual: Updated the "Package Splitting" section.
Rewrite included the "do_populate_sysroot" task and a bunch of
STAGING_DIR_* variables.

(From yocto-docs rev: 53484d4982a41f83ac9355aada46526b5d05f64a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:32 +01:00
Scott Rifenbark
6a70c9db88 overview-manual, mega-manual: Updated package splitting figure
More changes to the "analysis-for-package-splitting.png" figure.
I needed to work in "do_populate_sysroot" task and several
STAGING_DIR_* variables.

(From yocto-docs rev: fcb88024a7dfff1b6cca49770f67bf4c1f548362)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:32 +01:00
Scott Rifenbark
760e435e32 overview-manual: Changed title for configure/compile section.
The stage of the BitBake workflow is really "Configuration, Compilation,
and Staging".  I updated the title to be such.

(From yocto-docs rev: 4aab6d001119aa8c52e09ef0f6f66694719add29)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:32 +01:00
Scott Rifenbark
8436b7a6a9 ref-manual: Updated the STAGING_DIR variable description.
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>
2018-05-24 17:16:32 +01:00
Scott Rifenbark
4f8364c056 overview-manual, mega-manual: Updated the config/compile figure
The figure had the wrong hierarchy for the "image", "recipe-sysroot",
and "recipe-sysroot-native" folders.  Moved out a level.

(From yocto-docs rev: e1f45b666b1cd589cee9c9ae6dba01467b991ef9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:31 +01:00
Scott Rifenbark
dd566a4dad overview-manual, mega-manual: Updated the package splitting figure.
Figure was out of date.

(From yocto-docs rev: 5b56862ec39fc05299cd6d468f13f75b74c3b800)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:31 +01:00
Scott Rifenbark
7815287d6b ref-manual: Updated the PKGDATA_DIR variable description
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>
2018-05-24 17:16:31 +01:00
Scott Rifenbark
8a2291f5e7 ref-manual: Updated STAGING_DIR_HOST variable description.
Fixed some grammar issues.

(From yocto-docs rev: 5d19e2102d1251dd4fa561995c29191c1489f7fc)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:31 +01:00
Scott Rifenbark
2029d463a7 overview-manual: Updated the "Configuration and Compilation" section
This section needed some verbiage tweaks.  Nothing major.  Just a
few modifications to help clarify some areas.

(From yocto-docs rev: 9deabf424387fd1441882ce8cf28ea69421ea237)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:31 +01:00
Scott Rifenbark
380dfcbd8f overview-manual, mega-manual: Updated Config and Compile figure
The "configuration-compile-autoreconfig.png" figure was badly
out of date.  It was not showing the two sysroot directories
and did not use the $BPN variable.  I have updated the figure
and placed in both the overview-manual/figures area and the
mega-manual/figures area.

(From yocto-docs rev: dba3b2b65f18870229dcb3dbcb8fadc099165894)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:31 +01:00
Scott Rifenbark
6cc546ca61 ref-manual: Revision updates to BUILDHISTORY_FEATURES variable.
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>
2018-05-24 17:16:31 +01:00
Scott Rifenbark
e1774e2023 overview-manual: Small revisions to "Patching" section.
(From yocto-docs rev: 081a60766b67e8822e0c841f3259ff633580149c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:31 +01:00
Scott Rifenbark
0b99c7dd2a ref-manual: Updated the FILESPATH variable description
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>
2018-05-24 17:16:31 +01:00
Scott Rifenbark
b6f84351f3 ref-manual: Added a link to the patching section in the SRC_URI variable
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>
2018-05-24 17:16:30 +01:00
Scott Rifenbark
445e13ae35 ref-manual: Review edits added to do_patch task
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>
2018-05-24 17:16:30 +01:00
Scott Rifenbark
47b7dcd345 sdk-manual, mega-manual: Updated devtool modify workflow diagram
Added detail for the step one.  Clearer.

(From yocto-docs rev: ef95d547180ce53fade7a3764f8d362422472c7a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:30 +01:00
Scott Rifenbark
dd0e423bfd sdk-manual: Updated devtool modify workflow section.
I found this section a bit loosely worded and could result in
confusion to a user ramping up with YP.  I have done an extensive
rewrite focusing on exact wordings.

(From yocto-docs rev: af64c07d259e06fb13572fc224636ed240037b57)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:30 +01:00
Scott Rifenbark
d77de6b09f ref-manual: Updated do_patch task description
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>
2018-05-24 17:16:30 +01:00
Scott Rifenbark
23d93c7bed overview-manual: Added a link to the do_patch task.
(From yocto-docs rev: 934de6a59cef6a7b80530de1ccbe7006bb196238)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:30 +01:00
Scott Rifenbark
02f9805957 overview-manual: Updated "Patching" section.
This section presents a deep dive into the patching phase of the
build process.  I removed the vague "apply=yes" reference and added
more references for the reader to read and learn about patching.

The bit about the SRC_URI parameters (i.e. "apply") is going to be
covered in the do_patch documentation since that is the task that
handles that stuff.

(From yocto-docs rev: 5a2c98543ccc9ed24d16bb9442b674532940c0da)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:30 +01:00
Scott Rifenbark
03a7ed331d overview-manual: Increased viewport for patching.png image.
(From yocto-docs rev: fb8419753846e391dfc1b2dd5973eaff7627c57a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:30 +01:00
Peter Kjellerstedt
27fb732a64 ref-manual: Updated the BUILDHISTORY_FEATURES variable description
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>
2018-05-24 17:16:30 +01:00
Scott Rifenbark
8dabbc9ff3 ref-manual: Added "Patching" section reference to do_patch task
(From yocto-docs rev: 48335f99d896994283042752bd9ec4d20bd6d363)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:30 +01:00
Scott Rifenbark
712b171f32 overview-manual: Converted paragraph on figure to note
The paragraph at the end of the section about the file
hierarchies is better cast as a note.

(From yocto-docs rev: 4e8a33be61ea1ea5db12fc5fc97832393213fb5d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:30 +01:00
Scott Rifenbark
bb1f84ea7b overview-manual: Updated the "patching.png" figure
The figure had a bad "PN" variable being used in the "S" directory.
This needed to be changed to "BPN".

(From yocto-docs rev: beafc55eb3646ecb96929e44538de952207f0b76)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:29 +01:00
Scott Rifenbark
86bac90936 overview-manual, mega-manual: Updated source-fetching.png figure
The figure was incorrect. Replaced the PN variable with BPN for
the "S" directory.

(From yocto-docs rev: 440edcdae932a83b6c32b51e85d97178a77b4bed)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:29 +01:00
Scott Rifenbark
304254e8ea overview-manual: Updated "Source Fetching" section.
I scrubbed through this section and provided much better
explanations of the inside workings of BitBake fetching source
with building recipes.  During that, I fixed an error where
the PN variable was being used rather than the BPN variable.

(From yocto-docs rev: 5765987259ac46f140e099d8e1da2ab33f006d36)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:29 +01:00
Scott Rifenbark
3391d1d8e2 ref-manual: Updated the TARGET_OS variable description
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>
2018-05-24 17:16:29 +01:00