Commit Graph

862 Commits

Author SHA1 Message Date
Scott Rifenbark
f91f4b9b36 documentation: Updated "OpenEmbedded-Core" terms.
Throughout the manual set, I made sure that "OpenEmbedded-Core"
and "OE-Core" appear with the hyphens.

(From yocto-docs rev: 1f570df3eccb74b9e2e60af94c0e0dd48e1489e9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:08 +01:00
Scott Rifenbark
cbe4169d4f ref-manual: Updated LAYERSERIES_COMPAT description.
Using "OpenEmbedded-Core" rather than "OpenEmbedded Core" in the
text.  The term as also fixed to reflect this change.  Also,
use of the phrase "OpenEmbedded-Core project" or "OE-Core project"
is not desirable.  Changing project to version.

(From yocto-docs rev: ec226fcd92847c96ea2e11d34513b597a35c9825)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:08 +01:00
Scott Rifenbark
7d62867874 ref-manual: Updated LAYERSERIES_COMPAT variable description.
Minor re-wordings from review.

(From yocto-docs rev: d4598e7e43a8bafa4ff6ddeec50febcedc41b411)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:08 +01:00
Scott Rifenbark
67158570bc ref-manual: Fixed two grammar errors.
(From yocto-docs rev: 23a0edc13f2306008c0bbb154fb0861f15d4e6de)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:08 +01:00
Joshua Watt
f2e51380fb ref-manual: Updated the SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS variable
Describes the new wildcard syntax

(From yocto-docs rev: e91db865686e7b1b9b21cb9aea892b0ed8884438)

Signed-off-by: Joshua Watt <jpewhacker@gmail.com>
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:05 +01:00
Scott Rifenbark
424f544ecd ref-manual: Added variable description for SPL_BINARY
(From yocto-docs rev: 00e579123540006c364f7751a37e29c74acf361b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:05 +01:00
Scott Rifenbark
dbf6a1f778 ref-manual: Updated the IMAGE_BOOT_FILES varaible.
Added a final paragraph that provides some cross-referencing to
the sections that describe how to use Wic and to the Wic
reference chapter.

Also, shortened the DOC info line.

(From yocto-docs rev: 4ba5d0119caa3696187537f5b4cc9c64ca00e205)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:05 +01:00
Scott Rifenbark
2bb3bcf49c ref-manual: Updated SERIAL_CONSOLE and SERIAL_CONSOLES variables.
Added a link to the "getty" term.

(From yocto-docs rev: d21fe1ea33353e15c135af7fc302ffe636310541)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:04 +01:00
Scott Rifenbark
efa4b3040d ref-manual: Updated IMAGE_INSTALL variable description.
Minor edits for clarification.

(From yocto-docs rev: fdef057927b7b0dba64b9b7f952108fdb9c97f34)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:04 +01:00
Scott Rifenbark
85976e1d32 ref-manual: Updated EXTRA_IMAGECMD variable.
Added minor edits to clarify that we are talking about an
image type.

(From yocto-docs rev: 14c906aa539d127c88d71d7fb3e628fc225cbd52)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:04 +01:00
Scott Rifenbark
6b8a529dbf ref-manual: Added new variable description LAYERSERIES_COMPAT
Created a new variable description in the glossary.  This
variable is used in the layer.conf file and needed to be
documented.

(From yocto-docs rev: 5c514c0e90ca920bdf183b1f9449a06b906235ca)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:03 +01:00
Scott Rifenbark
8986a6f589 ref-manual: Updated PACKAGES_FEED_ARCHS variable
Added the fact that this variable is really optional.  If  you
don't use it then you are setting up a package feed URI that
will include all supported arcchitectures for the package.
Using it means you are setting up specific URIs for specific
architectures.

Added a "Tip" note box to show how you can use the variable
to whitelist architectures.

(From yocto-docs rev: 009f3551aa61aaf6459fd24105a2e06511b59da3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-25 09:41:12 +01:00
Scott Rifenbark
a2ed012df7 ref-manual: Updated the IMAGE_INSTALL variable description.
I created a two-bullet "Caution" note to highlight the stuff a
user needs to be aware of that can cause problems.

(From yocto-docs rev: 553bc13e5fd350adb15400afe170e587965929db)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-25 09:41:12 +01:00
Scott Rifenbark
bb4ab5a653 ref-manual: Updated PREFERRED_PROVIDER variable
Provided more details in the explanation and fixed a link to the
section on using virtual providers.

(From yocto-docs rev: ace74e24f001b83c9177266b0a6f15ce96dd04b0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-03 08:35:25 +00:00
Scott Rifenbark
813772451f documentation: Moved the detailed build section to concepts-manual.
The section that provides a closer look into the build system has
moved from the getting-started manaul to the concepts-manual.
I fixed all the links, provided some coded formatting of the
entire section, and made general updates.

The other manuals had links that needed fixed due to the move.

(From yocto-docs rev: b83a5619f56ebd9879fdcadcf474859e68b26d58)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:31 +00:00
Scott Rifenbark
6512622882 documentation: Updated links into new concepts-manual
Creation of a new concepts manual and moving of chapters from the
getting-started (overview-manual) caused many links and manual
reference titles to break.  I fixed these throughout the YP
docs.

(From yocto-docs rev: 30f2bc46be4a0faf5302eb8605bcb29f3bee6cf3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:31 +00:00
Scott Rifenbark
4d623003f3 documentation: Purged overview manual references
When I converted the Yocto Project Overview Manual to the Getting
Started With Yocto Project Manual, I updated the strings for
references from "&YOCTO_DOCS_OVERVIEW_URL" TO
"&YOCTO_DOCS_GS_URL".  Unfortunately, I did it with a global command
that did not take into account the text the might follow the link
by saying "see such-and-such section in the Yocto Project Overview
Manual."  So, I had to hand fix these.

Additionally, since I have moved a deeper concepts chapter that
was in the getting-started manual to a new Yocto Project Concepts
chapter, many of those links changed had to really go to the new
manual instead.  Those were fixed.

(From yocto-docs rev: fca1c56b0764802fb6a687ea81ab0fb95186cf0a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:30 +00:00
Scott Rifenbark
ae06e04cd2 documentation: Created new "Getting Started" manual.
Creation involved removing the overview-manual and replacing it
with the getting-started manual.  All links to the string
"&YOCTO_DOCS_OVERVIEW_URL" had to be replaced with
"&YOCTO_DOCS_GS_URL" across the entire YP manual set.  I renamed
files used to create the manual with prefixes suited for the
new manual name, which is "Getting Started With Yocto Project".

The style sheet for the new manual needed updating to display the
new .PNG image for the title page.  The mega-manual file had to
be updated to include the files.  The mega-manual.sed file had
to be updated to include the new manual and not use the overview
manual.

(From yocto-docs rev: 6c7abf9192390121000f577d6c98f259d290d15d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:29 +00:00
Scott Rifenbark
ebc7de0948 ref-manual, dev-manual: Moved "Speeding Build" to dev-manual
Fixes [YOCTO #12370]

The section on "Speeding Up a Build" that was in the ref-manual
needed to be in the dev-manual as it is a "how-to" section.
Moved it.

(From yocto-docs rev: 44d2889a4f3fb5dfabb1ea4df68a1b8bbf9347c8)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:29 +00:00
Scott Rifenbark
355103f8cf dev-manual, ref-manual: Moved build history info to dev-manual
Fixes [YOCTO #12370]

The section in the ref-manual on build history has been moved to
the dev-manual.  It is more of a "how-to" piece of information than
a reference.

(From yocto-docs rev: 9634bd8dc51e2972e6a5f3a3d3b4256c8ca8749c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:29 +00:00
Scott Rifenbark
0d52f18d39 dev-manual, ref-manual: Consolidated debug info into dev-manual
Fixes [YOCTO #12370]

Moved the debug information from the ref-manual to the dev-manual
where other debug information exists.  We now have a single area
(section) that deals with various debugging techniques and tips.

(From yocto-docs rev: 95394197fc04981bf7571e581ff8a0fd9c76223f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:29 +00:00
Kristi Rifenbark
a59c06833c ref-manual: Variable Definition Edits for documentation.conf
Fixes [YOCTO #5600]

Grammar scrub of variable definitions in documentation.conf

(From yocto-docs rev: 199fdc55aae4f34d95988ee2e43f3524fe82714a)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:29 +00:00
Kristi Rifenbark
bb6a218b6f ref-manual: Variable Descriptions for documentation.conf
Fixes [YOCTO #5600]

Grammar scrub on all variable description for documentation.conf

(From yocto-docs rev: 3054b1e4649d232f08f1065bad96b90eed57d517)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:28 +00:00
Scott Rifenbark
98a0739e59 overview-manual, ref-manual: Moved "Licenses" to overview-manual
Fixes [YOCTO #12370]

The "Licenses" section in the technical details chapter of the
ref-manual was concepts and needed moved to the new overview-manual.
Some links were broke during the move and they were fixed in the
BSP and dev-manual.

(From yocto-docs rev: 34c013f055736dcde2fe12daea1aaf2beaee97c5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:28 +00:00
Scott Rifenbark
99980546fa overview-manual, ref-manual: Moved Pseudo and Fakeroot to overview manual
Fixes [YOCTO #12370]

The "Fakeroot and Pseudo" section is concepts and needed moved from the
ref-manual to the new concepts chapter of the overview-manual.  Some
links needed to be fixed as well.

(From yocto-docs rev: df2c09407abd5ca468fcd0bd9e241739907a9d63)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:28 +00:00
Scott Rifenbark
a60d9e2917 overview-manual, ref-manual: Moved auto added runtime deps section
Fixes [YOCTO #12370]

The "Automatically Added Runtime Dependencies" section moved from the
ref-manual to the overview-manual.  This topic is concepts and needs
to live in the new overview-manual's concepts chapter.  Fixed some
links in the ref-manual and one in the dev-manual.

(From yocto-docs rev: fa3e12030ce867cb81feed453d35c3a3643decd2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:28 +00:00
Scott Rifenbark
00f87f8416 overview-manual, ref-manual: Moved "Shared State Cache" to overview manual
Fixes [YOCTO #12370]

The section on shared state cache needed to be in the overview manual
and not in the ref-manual.  I moved it.  Some links were affected,
which I fixed.

(From yocto-docs rev: 1c4e5207bdde19d4b48ef42b1de81390d8a02d64)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:28 +00:00
Scott Rifenbark
6bf7b263ff ref-manual, overview-manual, Makefile: Moved toolchain concepts
Fixes [YOCTO #12370]

Moved the "Cross-Development Toolchain Generation" section from the
ref-manual to the overview-manual into the concepts chapter.  This
information is conceptual and now needs to live in the concepts
chapter of the new overview-manual.  Moving the section caused a
few links to have to be fixed in the ref-manual.  There was also a
figure in the section.  So, I had to move the figure from the ref-manual
to the overview-manual "figures" folder and update the Makefile for
the TARFILE generation.

(From yocto-docs rev: 1f3ee5ab308cbe6bd7194086026db397b67ca7c4)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:28 +00:00
Scott Rifenbark
707224b57a ref-manual, overview-manual, yocto-project-qs: Moved YP Components
Fixes [YOCTO #12370]

Moved the "Yocto Project Components" section from the ref-manual to
the overview-manual.  This material falls into the "concepts" area
and is being moved from the ref-manual.  One link in the
yocto-project-qs was affected and updated.  Oh... another link in the
ref-manual for a variable also fixed.

(From yocto-docs rev: 75ced485bb223373591eb41d1b343d0c2b315345)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:27 +00:00
Scott Rifenbark
160b202d62 ref-manual: Fixed targets for sdk-manual links
I had tried using a #-type target for some links designed to go
to the top of the sdk-manual. It was not working out so I removed
the targets. The links now render benign for the mega-manual as
they should and render hot for the individual manual as they should.

(From yocto-docs rev: 05e20792fa6c93618499f06adfa2d4b82f24275a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:27 +00:00
Scott Rifenbark
b797db0db4 documentation: Created new YP Overview Manual
Fixes [YOCTO #12370]

Added a new chapter to the newly created Yocto Project Overview
Manual.  This chapter originated from the YP Reference Manual and
was the old chapter 3, which talked a lot about various concepts.
This information is better suited for the new overview manual.

The change involved moving the entire chapter and renaming it.
This move of the content affected many, many external references
and links into the old area.  Consequently, I had to recast all
these links from the different manual.

Changes also included fixing the mega-manual.xml file so that it
would include the new overview manual as part of it.

Many figures had to be relocated as part of the move as well.  This
meant deleting them from the ref-manual/figures folder and putting
them into the overview-manual/figures folder.

(From yocto-docs rev: 87b81358f2bbd02b4a0d966d86c4d7b006d4d78f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:27 +00:00
Kristi Rifenbark
c1e0242aaa ref-manual: Added BBFILES_DYNAMIC variable to glossary
FIXED [YOCTO #12089]

(From yocto-docs rev: 0906e9080e1c150feab60bb9d095688d274a061e)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-22 22:23:06 +00:00
Kristi Rifenbark
a52dc0a11e ref-manual: Added the GCCPIE Variable to Glossary
(From yocto-docs rev: b30f3d3bd6f6d333b00fc9c3797126a898fb0685)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-09 14:29:07 +00:00
Kristi Rifenbark
3f0cd2a1d7 ref-manual: Added the BB_SERVER_TIMEOUT variable to glossary
(From yocto-docs rev: 6e765f4017ae300f83839201b123afa2a3662d70)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-09 14:29:07 +00:00
Scott Rifenbark
708455cdee ref-manual: Updated links to the sdk-manual
The title of the sdk-manual changed.  Many links were updated to
render to the correct book title.

(From yocto-docs rev: 821e29c6c031ae2516fb0e79d0ec3936a5bd624c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:08 +00:00
Scott Rifenbark
caf6f814ad ref-manual: Updated EFI_PROVIDER variable description
The "vmdk" image has essentially changed to "wic.vmdk".  I updated
the description by replacing "vmdk" with "wic.vmdk".

(From yocto-docs rev: 24d0d9509361afe0d61449c7dd056f73318fc01a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:07 +00:00
Scott Rifenbark
7fe44a4570 ref-manual: Cleaned up multiple notes for the IMAGE_FSTYPES variable
Combined two note boxes into a single note box with bulleted list.

(From yocto-docs rev: 5684b6cf373ddc5b18e9e4ae4ae12cede30b8235)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:07 +00:00
Scott Rifenbark
42ba96fe24 ref-manual: Converted external links to internal and fixed dev-manual Links
The dev-manual title changed to the Yocto Project Development Tasks
Manual.  I fixed links to this manual.  Also converted several external
links to internal.

(From yocto-docs rev: 3ec8452d4f847654096f68c90bf2f7003f5e585c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:06 +00:00
Scott Rifenbark
4320b808c2 ref-manual, dev-manual: Updated "Creating Partitioned Images" section title.
Added "Using Wic" to the section head because that is all we
talk about.  This affect three links in the ref-manual so I
fixed those as well.

(From yocto-docs rev: 0e4f245f2b872810e2e164a227900ca6aa313ab8)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
Scott Rifenbark
cbe8009a17 dev-manual, ref-manual: Moved kickstart reference to ref-manual
This section was misplaced in the dev-manual and really needed to
be in the ref-manual.  I created a new chapter that follows the
devtool reference chapter and put the kickstart chapter there.

Links were needed to be fixed up and a new chapter in the
ref-manual named ref-kickstart.xml had to be created.

(From yocto-docs rev: b4d5b7077a978e4966d1273a374741075a1b0c7d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
Scott Rifenbark
6cee5c8b9b ref-manual: Updated a cross-link to the creating partitioned images section
This link is going to a link that disappearing.  So had to re-route
it to a different spot.

(From yocto-docs rev: 8b2a3eafa10b1f6fdf034e6e13d0277c9a556170)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
Scott Rifenbark
0b75283fa9 ref-manual: Updated the FILESEXTRAPATHS variable
Added an example to show machine overrides.

(From yocto-docs rev: d0c54caf2a2a6ccb9a6fb38b77c9827b66b9ff10)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:51 +01:00
Scott Rifenbark
f83991dc04 ref-manual: Updated KERNEL_FEATURES variable description
Added a more relevant example from the 4.12 Yocto Linux kernel
recipe.

(From yocto-docs rev: 98c40729b2b22a2ac8444d899848c05880cb920b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:34 +01:00
Scott Rifenbark
94e71dea32 ref-manual: Updated KBRANCH variable description
The description had gone stale and was referencing a linux
yocto kernel we don't support and BSPs we don't support.  Updated
it.

(From yocto-docs rev: 5041a2a26d703a885437abcedb24c7600d5365cd)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:33 +01:00
Kristi Rifenbark
adcb7b7e73 ref-manual: Added NOAUTOPACKAGEDEBUG to variable glossary
Fixes [YOCTO #11800]

(From yocto-docs rev: 789a11aee778f6082134102659b317bc6c155b4c)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:32 +01:00
Scott Rifenbark
3ad1f402d9 ref-manual: Updated kernel example version in PREFERRED_VERSION.
(From yocto-docs rev: bc6960c01cffdc2cef7c9288db9daeed2c3e1a25)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-26 11:18:59 +01:00
Scott Rifenbark
cc601ade6f ref-manual: Updated link formatting in KBUILD_DEFCONFIG variable.
(From yocto-docs rev: ba2aa642c3c1696a155b07840f84b8b3f0e692b5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-26 11:18:59 +01:00
Scott Rifenbark
f94f6e655f dev-manual, ref-manual: Image format implementation changes
Recently a number of changes have happened on the implementation
side of some image formats, and a few have been renamed.
The u-boot image signing code is now always available and no
longer in a stand-alone file.  The vmdk/mdi/qcow2 images have
been removed and are now just a conversion type that is applied
to wic images.

Reported-by: Tom Rini <trini@konsulko.com>
(From yocto-docs rev: ce86da3d48507cee12208e0138c285b4be83d8cd)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-22 17:53:44 +01:00
Scott Rifenbark
b103ff6ba7 documentation: Purged "oe-init-build-env-memres" from docs
Fixes [YOCTO #11968]

Purged all occurrences of the "oe-init-build-env-memres" script
from the YP documentation set.  Occurrences in a lot of places.
The BBSERVER variable was also impacted and had to have the
definition updated.

(From yocto-docs rev: 274b05108d1bc53df20c11ab2efa15363bce23da)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-22 17:53:44 +01:00
Scott Rifenbark
2fe228645c ref-manual: Added "N" category to glossary
Discovered this item in the front of the glossary was commented
out and not showing up so the user did not have the option to
click on "N" to quickly get to the "N" entries, which did exist
and show up.  Uncommented it and put the proper beginning "N"
variable in as the start.

(From yocto-docs rev: 6d51dfb9de53db1222f68a6f0325eaad1a12cd6b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-22 17:53:44 +01:00
Kristi Rifenbark
574633641a ref-manual: Updated PREFERRED_PROVIDER variable
Fixes [YOCTO #11762]
Added a link from variable to new virtual providers
section.

(From yocto-docs rev: d87726cf4962ca093c63d23d9e04f41d448c9594)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-13 18:00:18 +01:00
Kristi Rifenbark
1d42e21db4 ref-manual: Added missing variables to glossary
Fixed [YOCTO #10642]

Added the following variables:
BUILD_CC_ARCH
BUILD_LD_ARCH
BUILD_AS_ARCH
BUILD_FC
BUILD_LD
BUILD_CCLD
BUILD_STRIP

(From yocto-docs rev: eb602d0a5fca67228607710d5d33873f1b0529f1)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-13 18:00:18 +01:00
Kristi Rifenbark
07ca1d57dc ref-manual: Added review comments
Added review comments to variables COMPONENTS_DIR,
and SYSROOT_DESTDIR. Added review comments to
task do_prepare_recipe_sysroot.

(From yocto-docs rev: 362998c71b44ddf89d32ed5c45e4251e932a9217)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:49 +01:00
Kristi Rifenbark
47883ade9d ref-manual: Added new variable COMPONENTS_DIR to glossary
Added new description and created a link for an
existing occurance of the variable.

(From yocto-docs rev: 9ab6e6aed685c9419cb7df3df3ab029033d9ba0e)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:49 +01:00
Kristi Rifenbark
79f860e146 ref-manual: Updated SSTATE_SCAN_FILES variable description
(From yocto-docs rev: 190b257e788d7f6f2f87e4e8c031bcda4a9f6d46)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:48 +01:00
Kristi Rifenbark
d8b1b09455 ref-manual: Added new variable
Added SYSROOT_DESTDIR to the variable glossary.

(From yocto-docs rev: 37388eccf162811ba7b9fd3ee3c110a8fa0f2556)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:47 +01:00
Scott Rifenbark
aa1162685f ref-manual: Cleaned up the description of INITRAMFS_IMAGE variable.
(From yocto-docs rev: a85647193c202fcd36c70122240b54aa5672c895)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:15 +01:00
Scott Rifenbark
6a7d93155b ref-manual: Updated INITRAMFS_IMAGE variable description.
The description suggested the reader see the
meta/poky/conf/local.conf.sample.extended file for more understanding
on INITRAMFS_IMAGE.  The actual file is
meta-poky/conf/local.conf.sample.extended.

(From yocto-docs rev: 80b474d3417e88a47d1317b2af6552698e907b80)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:15 +01:00
Changhyeok Bae
d634fa2e9d ref-manual: uClibc Replaced by musl from Yocto 2.2
(From yocto-docs rev: ed7e62f5937576d7878eb955fda12c18e787db18)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:45 +01:00
Kristi Rifenbark
a331904ab2 dev-manual: Fixed two grammar errors
(From yocto-docs rev: 4e68646edf078c23e414a300b37cb30774b28be7)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:44 +01:00
Scott Rifenbark
ba34d31ed9 ref-manual: Updated the LAYERRECOMMENDS variable description
Fixes [YOCTO #11579]

I removed the sentence about throwing an error or warning.

(From yocto-docs rev: cfa3b1559122ec9e927ccd34afa0e26e877486f9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:43 +01:00
Scott Rifenbark
f42d8f4cf0 documentation: Fixed links for "metadata" term.
Fixes [YOCTO #11630]

Moving the "Yocto Project Terms" section from the dev-manual
to the ref-manual broke the links to the "Metadata" term.
I fixed these.

(From yocto-docs rev: 190da4b4d44952d141db26ca72b5bc1a52d77023)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:43 +01:00
Scott Rifenbark
74bf586c94 documentation: Fixed links for "build-directory" term.
Fixes [YOCTO #11630]

Moving the "Yocto Project Terms" section from the dev-manual to the
ref-manual broke several links to the id "build-directory".  I fixed
these to reference into the ref-manual now.

(From yocto-docs rev: debe2ae8ce203ebe0f1cee0de54124c15df8bb7e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:42 +01:00
Scott Rifenbark
ded9a2f6b3 ref-manual: Updated PACKAGECONFIG_CONFARGS variable
Fixes [YOCTO #11600]

Removed the example.  It was not needed.

(From yocto-docs rev: 402bb173b00a665fb55a8f740a4dbe60ead57f25)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14 10:19:24 +01:00
Scott Rifenbark
a61cb95ebd ref-manual: Updated PACKAGECONFIG_CONFARGS variable description
Fixes [YOCTO #11600]

"configure" and "cmake" are not do_* tasks of BitBake.  I updated
the formatting of these programs and removed links that were to
the tasks in the reference manual.

(From yocto-docs rev: 2605c7378f6b4b49c2e2baaf159fd2c289d83a1a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14 10:19:24 +01:00
Scott Rifenbark
ce31b76fd1 ref-manual: Updated the PACKAGECONFIG_CONFARGS variable description
Fixes [YOCTO #11600]

Made some technical corrections to the PACKAGECONFIG_CONFARGS
variable description in the glossary.

(From yocto-docs rev: c422783984748f170943eab418bfa7d0111fa352)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-04 08:47:14 +01:00
Scott Rifenbark
d4503fbf26 ref-manual: Added LAYERRECOMMENDS variable description
Fixes [YOCTO #11579]

Added a new description for the LAYERRECOMMENDS variable.

(From yocto-docs rev: 3004a5724c4ea7165e4f749f9c9237ee1fbd89f5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-04 08:47:14 +01:00
Scott Rifenbark
078408643e ref-manual: Updated LAYERDEPENDS variable description
Fixes [YOCTO #11579]

The syntax for specifying a layer version was incorrect. I
have added an explanation for the correct syntax and provided
an example.

(From yocto-docs rev: 5703fb2f8b9d3df408c596603b8b8416597fc67a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-04 08:47:14 +01:00
Scott Rifenbark
b7626dc36f ref-manual: Updated image-live.bbclass description
Fixes [YOCTO #9001]

Updated the image-live class description to specifically mention
creating *.iso and *.hddimg images as "live" images.  Provided more
explanation about usage through the NOISO and NOHDD variables.

Also, provided a cross-referencing link back to the updated
image-live class from the EFI_PROVIDERS variable.

(From yocto-docs rev: 788061b2911339c8396b798a0ab5635ab5bb89e1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-18 13:18:56 +01:00
Scott Rifenbark
69d1f536e4 ref-manual: Enhanced the glossary description for INHERIT
Fixes [YOCTO #11498]

I enhanced the description of the INHERIT variable's glossary
description to provide more detail.  I also included a link into the
section of the BB manual where INHERIT is described.

(From yocto-docs rev: 663cde3cf05ebf564ff3a28cd37b696be2f91ad8)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-18 13:18:56 +01:00
Scott Rifenbark
171b714ed2 ref-manual: Added 4 DISTRO_FEATURES* variable descriptions.
Added the following:

 * DISTRO_FEATURES_NATIVE
 * DISTRO_FEATURES_NATIVESDK
 * DISTRO_FEATURES_FILTER_NATIVE
 * DISTRO_FEATURES_FILTER_NATIVESDK

to the variables glossary.

(From yocto-docs rev: ee68291c32cdbf8004c24295784c0f70f02c0a55)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-10 12:13:32 +01:00
Scott Rifenbark
b1dc0ee121 ref-manual, dev-manual: Completed first draft of 2.3 migration section.
(From yocto-docs rev: 42ab9e34da640b46d39741c9c83648dc65518ec1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-10 12:13:32 +01:00
Scott Rifenbark
744cd8cfd7 ref-manual: Added new glossary entries for HOSTTOOLS* variables.
Entry added for HOSTTOOLS and HOSTTOOLS_NONFATAL.

(From yocto-docs rev: c766920a13071c1bb46a195ea07be38962d2e12d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-10 12:13:32 +01:00
Scott Rifenbark
c0dc8d492e dev-manual, ref-manual: Updated various wordings and links
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>
2017-04-20 08:16:38 +01:00
Scott Rifenbark
3db3344859 ref-manual, dev-manual: Updates to support recipe-specific sysroots
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>
2017-04-18 15:51:44 +01:00
Scott Rifenbark
94467d5087 dev-manual, ref-manual: Edits to the "Incrementing Binary Package" section.
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>
2017-04-12 19:35:00 +01:00
Scott Rifenbark
f9e7fba02f dev-manual, ref-manual: Created new section on linear revision for packages
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>
2017-04-12 19:35:00 +01:00
Scott Rifenbark
e2232e6813 dev-manual, ref-manual: Added PACKAGE_WRITE_DEPS and concept support
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>
2017-04-12 19:35:00 +01:00
Scott Rifenbark
1a4c0bfafd dev-manual; ref-manual: Updates to replace "smart" with "dnf"
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>
2017-03-31 12:14:17 +01:00
Scott Rifenbark
f574b9f074 dev-manual, ref-manual: Added support for WKS_FILE_DEPENDS variable.
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>
2017-03-24 23:44:02 +00:00
Scott Rifenbark
e6ed5a6804 ref-manual: Added five "COPYLEFT*" variables to the glossary.
Fixes [YOCTO #11021]

The "Maintaining Open Source License Compliance During Your
Product's Lifecycle" section in the dev manual covers use of
archiver.bbclass, but is missing mention of the filtering
options (e.g COPYLEFT_LICENSE_INCLUDE, COPYLEFT_LICENSE_EXCLUDE
and COPYLEFT_RECIPE_TYPES).  I added descriptions for these
three.  During the write-up, Paul noticed a couple other variables
missing: COPYLEFT_PN_INCLUDE and COPYLEFT_PN_EXCLUDE.  I also
added descriptions for these two variables.

(From yocto-docs rev: 450311037ea3048d30057c0b9d294efd33db2d3c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-24 23:44:02 +00:00
Scott Rifenbark
e504de2cf4 ref-manual: Updated NO_RECOMMENDATIONS glossary entry
Fixes [YOCTO #11010]

The second example was incorrect in the glossary entry.  Instead
of "1" an image name place holder was in the example.  I put "1"
in there.

(From yocto-docs rev: 00ab787d0d90da5c6d384c3669e804c9b2baca53)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-02-19 06:59:51 -08:00
Scott Rifenbark
62f7812b93 ref-manual: New VOLATILE_LOG_DIR variable description
Fixes [YOCTO #6132]

No mention of how to make the target directory /var/log
persistent.  I added a note to the "post-install-logging"
image feature that points to the new VOLATILE_LOG_DIR
variable description, which I added to the glossary.

(From yocto-docs rev: 5d2bdf49e569e44d02602501d72418f04dbe6e4a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-01-11 17:23:17 +00:00
Scott Rifenbark
ecaab75be6 dev-manual, ref-manual: Created new section on initramfs
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>
2017-01-11 17:23:17 +00:00
Scott Rifenbark
d229fded3e ref-manual, dev-manual: Removed term "wic-partitioned"
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>
2017-01-11 17:23:17 +00:00
Scott Rifenbark
617b5bd4f3 ref-manual: Added WKS_FILE description for new variable
This new variable points to the location of the wics kickstart
file.

(From yocto-docs rev: 80d18224140f95fdca0b4efad8f6a6e545ee4d56)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-01-11 17:23:17 +00:00
Scott Rifenbark
8433efbd99 ref-manual: Updated KERNEL_IMAGE_BASE_NAME glossary description
Fixes [YOCTO #10717]

Now that multiple images can be built, the KERNEL_IMAGE_BASE_NAME
no longer requires "${KERNEL_IMAGETYPE}" as part of its default
value.  I have removed this portion of the default definition
described in the glossary.

(From yocto-docs rev: 713b3c141dfb66fc3852b5a997a7fc19d494e97b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-12-08 16:36:40 +00:00
Scott Rifenbark
479fbee840 ref-manual, dev-manual: Added references to SYSROOT_DIRS
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>
2016-11-23 11:10:35 +00:00
Scott Rifenbark
d2523d535f documentation: Added new appendix for customizing standard SDK
Fixes [YOCTO #8584]

This fix essentially had to document how to add the API
documentation to the standard SDK.  The fix required adding a
new appendix to the SDK manual on how to customize that
standard SDK.  I could not put just one topic in a new appendix
so I also added a sub-section on how to add indidual packages
to the standard SDK.

Other changes here were the introduction of a new file for the new
appendix, updated the mega-manual.xml file so that it would include
the new chapter when the MM was built.  Finally, I added some
cross-referencing to the new appendix from the TOOLCHAIN_HOST_TASK
and TOOLCHAIN_TARGET_TASK variables.  And a cross reference from the
distro features section on the api-documentation bullet.

(From yocto-docs rev: 1fb4321ae42253d1fc9602496b5e9e8b495197dd)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-11-16 10:38:42 +00:00
Scott Rifenbark
2b782a2c21 ref-manual: Added BBMULTICONFIG glossary description.
(From yocto-docs rev: 47edb1bbddead120bc976a920089d61426f8f223)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-25 17:55:37 +01:00
Scott Rifenbark
5f4b202078 ref-manual: Updated the RDEPENDS variable description.
Fixes [YOCTO #10445]

Pointed out that the EXTENDPKGV variable is hard to locate in the
BB manual.  Firstly, we don't document that variable in the
BB manual.... maybe we should.  For the ref-manual, however, it is
barely referenced in a side example from the dev-manual.  So, I
updated the RDEPENDS variable to have a "Tip" box in the area where
it is shown how to use the package version as part of the RDEPENDs
variable.

(From yocto-docs rev: 7aff5df538c27cf3c2700538e46e723cdb5d9986)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-25 17:55:37 +01:00
Scott Rifenbark
9c04beb9ad ref-manual: Removed RM_OLD_IMAGE variable description.
This variable is now redundant due to the way these image
files are staged now.  The variable does not need to be
in the glossary.  Removing the images is now the default
behavior.

Author: Joshua Lock <joshua.g.lock@intel.com>

(From yocto-docs rev: 049c371b44d3ef68def4ead7d1db8bf982d23c57)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-19 12:56:33 +01:00
Scott Rifenbark
2b08a281b9 ref-manual: Added note to RM_OLD_IMAGE indicating redundancy
The way these old image files are staged now makes removing them
the default behavior.  Thus, this variable has become redundant.
I added a note indicating such.

(From yocto-docs rev: e1db620fdf741b46e54cf1a3715597f81a811818)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-19 12:56:32 +01:00
Peter Kjellerstedt
1b1bc791da ref-manual: Updated the USERADD_ERROR_DYNAMIC and USERADDEXTENSION variables.
The value for USERADD_ERROR_DYNAMIC changed from "1" to "error"
to activate this variable.  Also, the value "warn" is used
to cause a warning to be issued.  I updated the variable
description to reflect this.

For the USERADDEXTENSION variable, I updated the [doc] string
to use proper quote marks.  I was not nesting these properly.

(From yocto-docs rev: f21277b3887134611fc567da05e8a590ecb0d7af)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11 08:51:22 +01:00
Scott Rifenbark
684a8753ab ref-manual: Added link in the SYSROOT_DIRS_NATIVE description
Fixes [YOCTO #10377]

Linkified the STAGING_DIR_NATIVE item in the the
SYSROOT_DIRS_NATIVE glossary entry.

(From yocto-docs rev: e02ecfac949b92ec32a621fccb0d1663bb7816ad)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11 08:51:22 +01:00
Scott Rifenbark
cda7141ad1 ref-manual: Review edits to do_populate_sysroot and SYSROOT_DIRS_NATIVE
Fixes [YOCTO #10377]

Some minor wordsmithing.  Also added a new note to the
SYSROOT_DIRS_NATIVE variable.

(From yocto-docs rev: 459666b01b8d6d8212a59c877ea6c324511a5883)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11 08:51:22 +01:00
Scott Rifenbark
6be52ddd9a ref-manual: Updated three SYSROOT_DIRS* variables.
Fixes [YOCTO #10377]

Provided links back into the do_populate_sysroot task and other
key variables.  I updated the SYSROOT_DIRS, SYSROOT_DIRS_BLACKLIST,
and SYSROOT_DIRS_NATIVE variables.

(From yocto-docs rev: 23ed80e4884b00e303a15d0d191bd0dca385b064)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11 08:51:22 +01:00
Scott Rifenbark
8312ba80fa ref-manual: Applied review changes to the STAGING_DIR_HOST
I basically moved the note from the bottome to a position
within the bulleted list.

Fixes [YOCTO #10348]

(From yocto-docs rev: a55dc7e0f8465abf8398f51d90bbe2df7e639b3f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11 08:51:22 +01:00
Scott Rifenbark
2083e83455 ref-manual: Updated the STAGING_DIR_HOST variable description.
Fixes [YOCTO #10348]

Added a note clarifying that -native recipes are not installed
into host paths.

(From yocto-docs rev: c0b4265350b558eec296c93f0829c3d687950c52)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11 08:51:21 +01:00
Scott Rifenbark
75e60f17e6 ref-manual: Updated the DEPENDS variable description
Fixes [YOCTO #10298]

Applied a small grammar fix to the description.

(From yocto-docs rev: d022a01af3f68e6e6311c47aef451e25bc8add5e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28 15:02:33 +01:00
Scott Rifenbark
e7e61507db ref-manual: Updated the DEPENDS variable description.
Small grammatical changes.

(From yocto-docs rev: efa1e9c3948f7dd240372a1a1c773286072fbccd)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28 15:02:33 +01:00
Scott Rifenbark
0d091dbd3e ref-manual: Applied small edits to the DEPENDS variable desc.
(From yocto-docs rev: 0ef73dc53a1d88689fdc88cd231b0fa72a6eee8b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28 15:02:33 +01:00
Scott Rifenbark
8a8349be29 ref-manual, dev-manual: Updates for "staging" discussion and variables.
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>
2016-09-28 15:02:33 +01:00
Scott Rifenbark
cd2a26c018 ref-manual: Updated the DEPENDS variable description
Fixes [YOCTO #10298]

Added a better front part description to the variable.

(From yocto-docs rev: ce8a093235aa78761fde66f345f993ab7cfac6c6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28 15:02:32 +01:00
Scott Rifenbark
826383984d ref-manual: Updated the PACKAGES variable description
Fixes [YOCTO #10294]

Provided text noting that if packages in the PACKAGES list are
empty are not generated, unless generation is forced through
the ALLOW_EMPTY variable.

(From yocto-docs rev: 1c89e0edf7e038f733b9b95bb884648d953b9574)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28 15:02:32 +01:00
Scott Rifenbark
ad1ba190df ref-manual: Updates to PKGDESTWORK and do_packagedata
Fixes [YOCTO #10248]

Provided more accurate descriptions for this variable and task.

(From yocto-docs rev: 422fa705165748230470fffc4fcc543ee38b1f2e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:34 +01:00
Scott Rifenbark
7d208c1c77 ref-manual: Applied review edits to auto added runtime deps
Fixes [YOCTO #10248]

Applied some review changes.  Minor wording tweaks and typo
fixes.

(From yocto-docs rev: a9e99c8b44c48c74448487187cebfe8df331e9e1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:34 +01:00
Scott Rifenbark
6cecded9ef sdk-manual, ref-manual: New variable for including toolchain
Added a new variable description for SDK_INCLUDE_TOOLCHAIN.
Along with the new glossary entry, I updated a couple places
where it would be relevant to cross-reference the new variable.

(From yocto-docs rev: df99b097595e7488a93354082b8d9f33acd9c229)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:34 +01:00
Scott Rifenbark
4824bb4fda ref-manual: Added note to PREFERRED_VERSION
fixes [YOCTO #10252]

Added a note to help avoid confusion regarding the version
specification used in PREFERRED_VERSION.

(From yocto-docs rev: 38edc25b04c1a6d673ceb25f5548898d5b63b120)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:34 +01:00
Scott Rifenbark
8bc6c1c2c8 ref-manual: New section and updates for runtime dep work
fixes [YOCTO #10248]

The bulk of this change is a new section called "Automatically
Added Runtime Dependencies".  Additionally, changes were made
to the RDEPENDS and DEPENDS variables. Some cross-referencing
to the new material was also added in the do_package task entry,
the do_packagedata task entry, the PKGDATA_DIR glossary entry,
and the PRIVATE_LIBS glossary entry.

(From yocto-docs rev: 16504cd0eb23e102322c6c6096c5b52500a04640)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:34 +01:00
Scott Rifenbark
72d1435f20 documentation: Added new description for the PACKAGECONFIG_CONFARGS variable.
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>
2016-09-23 15:27:33 +01:00
Scott Rifenbark
11e9d10d08 ref-manual: Added variable description for PACKAGECONFIG_CONFARGS
Fixes [YOCTO #10183]

(From yocto-docs rev: 8ad71d720e6f1a1d23d5879a14600ade86e2bc46)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:33 +01:00
Scott Rifenbark
0de57677c3 yocto-project-qs, ref-manual: Updated Python requirement to 3.4.0
This is the minimum requirement for YP 2.2 release.

(From yocto-docs rev: 0aebdd8556a6e5a52c0caf28dc97c1872b40e950)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:33 +01:00
Scott Rifenbark
5f5671e03c ref-manual: Removed link to ROOTFS_RO_UNNEEDED.
Fixes [YOCTO #9899]

This variable does not need documented in the glossary.

(From yocto-docs rev: 4082b752239025c8696bb248a20ac1fb5380c7af)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:32 +01:00
Scott Rifenbark
2a2ccb0436 ref-manual: Added new note item to the DEPENDS note box.
Fixes [YOCTO #10198]

The new note helps clarify runtime dependencies.

(From yocto-docs rev: e9eba1260df4ef5f3245149f0436eae5ca68c78b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:32 +01:00
Scott Rifenbark
4b8e7d8cca ref-manual: Updated the MLPREFIX variable description.
Fixes [YOCTO #10197]

Provided better examples and a bit of a historical note.

(From yocto-docs rev: 5845aadcc4e6932abde4ce7c74834c0f2a9fb806)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:32 +01:00
Scott Rifenbark
007193cdf2 ref-manual: Added variable description for FORCE_RO_REMOVE.
Fixes [YOCTO #9899]

I put this new variable description in.

(From yocto-docs rev: 32040277a921d0013256bed5aa7e32e14d1220ba)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:32 +01:00
Scott Rifenbark
c3adec966e ref-manual: Updated CLASSOVERRIDE with a new example.
(From yocto-docs rev: 057e79672769eb1fbec87695a0084f42955f757d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:32 +01:00
Scott Rifenbark
3fa0f9d3ee ref-manual: Updated the DISTROOVERRIDES variable description.
Fixes [YOCTO #10176]

Provided a more complete description of this variable.

(From yocto-docs rev: 164bf11250c965aadd1ee1573267aa31daa8a4e8)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:32 +01:00
Scott Rifenbark
2233924ee6 ref-manual: Updated the MACHINEOVERRIDES variable description
Fixes [YOCTO #10175]

Provided a more detailed description of this variable.

(From yocto-docs rev: 95a80313dfb276425020a61d199b75d259b47ff1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:32 +01:00
Scott Rifenbark
44b0b07a6f ref-manual: Rewrite of the CLASSOVERRIDE variable in the glossary
Fixes [YOCTO #10174]

I applied a more descriptive explanation of this varialbe.

(From yocto-docs rev: 7c6c2645b7e74e1c7de0d43b35307c8917648959)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:32 +01:00
Scott Rifenbark
43b9962cdd ref-manual: Grammar fix in the OVERRIDES variable description.
(From yocto-docs rev: cae94f6b5595e3674af041110d89f736f833cc88)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:32 +01:00
Scott Rifenbark
e0347ec2dc ref-manual: Clarified the OVERRIDES glossary description.
Fixes [YOCTO #10173]

I provided a more detailed description of how this variable
works.  Also provided a cross-reference link back to the
variable at the end of the PREFERRED_VERSION variable.

(From yocto-docs rev: 679b205eea541b89e220656f7aa304d0f343c8a6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:32 +01:00
Scott Rifenbark
f1879193b9 ref-manual: New section clarifying stamps, input checksums and sstate cache
Fixes [YOCTO #10172]

I added a new section on how BitBake reruns tasks based on the
stamps files.  Also put in some cross-referencing links to that
new section in the stamps entry for the structure chapter and in
the STAMP variable in the glossary.

(From yocto-docs rev: da8779d9eb85473cd6b0f74e9e1371e1d277890f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:32 +01:00
Scott Rifenbark
ba8bc1ba39 ref-manual: Updated systemd-boot documentation link.
Fixes [YOCTO #9707]

The original link was bogus.  I applied four instances to fix the
link.

(From yocto-docs rev: f03d5af6ddf0430cf98332c5d54f3fe68fb69cf9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23 15:27:31 +01:00
Scott Rifenbark
2fedd226c3 ref-manual: Fixed small wording in PKGR in the glossary
Fixes [YOCTO #10138]

(From yocto-docs rev: e49e5055e48f3c426090d2bc62b2bffbc2577dd0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-25 23:09:29 +01:00
Scott Rifenbark
08e3ef9808 ref-manual: Updates to PKGV, PKGE, and PKGR.
Fixes [YOCTO #10138]

Small wording changes.

(From yocto-docs rev: 66afe7560f086ea350df92b2b40ce5790d3d523c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-25 23:09:29 +01:00
Scott Rifenbark
9ba4fc087e dev-manual, ref-manual: Systemd-boot: Update documents for new EFI bootloader
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>
2016-08-25 23:09:29 +01:00
Scott Rifenbark
a2e8f196d7 ref-manual: Updated some variables in the glossary for nits.
Fixes [YOCTO #10138]

Small fixes for the following variables:

 * PKGV
 * PV
 * PE
 * PR

(From yocto-docs rev: 4ffc6a2fed330cec320e744561df3aad2a349cf5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-25 23:09:29 +01:00
California Sullivan
bfd0850e76 ref-manual: Update SERIAL_CONSOLES_CHECK description
The previous description was not accurate. Looking at the code,
SERIAL_CONSOLES_CHECK does not act like SERIAL_CONSOLES, as it
will not add consoles to enable but only check and disable
consoles defined by SERIAL_CONSOLES. Also, the previous patch
adds aliasing functionality that needed to be documented.

I (Scott Rifenbark) did a bit of word-smithing here from the
original patch.

(From yocto-docs rev: 55d07048e831f0dbc955b74e029fe26ed276675b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-19 08:40:23 +01:00
Jonathan Liu
dfb899d9c3 ref-manual: change SYSLINUX_ROOT to ROOT_VM for DISK_SIGNATURE variable
The SYSLINUX_ROOT variable was renamed to ROOT_VM in krogoth.

(From yocto-docs rev: c4bbe8bc4967dd631b939f6806d65e2862df3424)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-19 08:40:23 +01:00
Scott Rifenbark
feda248d59 ref-manual: Various small corrections to package-related stuff
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>
2016-08-18 23:50:47 +01:00
Scott Rifenbark
72ebd62821 ref-manual: Updated PROVIDES and FILES variable descriptions
Fixes [YOCTO #10094]

For PROVIDES, I added information about how the do_package
task goes through PACKAGES and uses the FILES variable
corresponding to each package to assign files to the package.

For FILES, I added a blurb to the existing note how you can
find default values for the FILES* variables.

(From yocto-docs rev: c70f79a608076c5c0490918b87986554bc5d8353)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-18 23:50:47 +01:00
Scott Rifenbark
5337ac972f ref-manual: Updated the SERIAL_CONSOLES_CHECK variable description.
Provided a better, more accurate description of this variable.

(From yocto-docs rev: 020f927bc01d662601fb44b19e4c6bc70e5e5ee7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-18 23:50:46 +01:00
Scott Rifenbark
efb62666c7 ref-manual: Changed the BPN variable description.
Fixes [YOCTO #10068]

Removed redundant wording.

(From yocto-docs rev: b6c9c979a01c8070d3d2c23340d3c0f5ef358157)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-18 23:50:46 +01:00
Scott Rifenbark
df337651e4 ref-manual: Updates to PARALLEL_MAKE, PARALLEL_MAKEINST, EXTRA_OEMAKE
Fixes [YOCTO #10070]

Updated these three variables with various items to make clear
that PARALLEL_MAKE and PARALLEL_MAKEINST won't work unless
EXTRA_OEMAKE is passed to "make".

(From yocto-docs rev: 4f8b56cc67502cd672e0296cf2f143ecbcde22ac)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-18 23:50:46 +01:00
Scott Rifenbark
836b80cca2 ref-manual: Added note to PROVIDES variable description.
Fixes [YOCTO #10069]

Added a note at the end of the variable description to
explain how runtime virual dependencies work.

(From yocto-docs rev: de1d16017c27b6b2502735fc41acd22660f6e7b9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-18 23:50:46 +01:00
Scott Rifenbark
b88973f637 ref-manual: New "Fakeroot and Pseudo" section.
Fixes [YOCTO #10060]

I provided a new section in the Technical Details chapter.  Also
some extra explanation was added to both the do_install task and to
the D variable.

(From yocto-docs rev: 565fb11d72bf8c585469bcf65f92b6738e344813)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-18 23:50:46 +01:00
Scott Rifenbark
c78c5006ec ref-manual: Added new variable description EXTRANATIVEPATH.
Fixes [YOCTO #10002]

Created new base description for EXTRANATIVEPATH.

(From yocto-docs rev: aafc2de2657203440fe4b0bf3895cf367063bed1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-18 23:50:46 +01:00
Scott Rifenbark
9576ddc6b3 ref-manual: Applied review changes to INITRAMF_IMAGE variable.
Fixes [YOCTO #10012]

There was a mistake referring to the wrong example recipe.  I
changed "core-image-sato-initramfs.bb" to
"core-image-minimal-initramfs.bb" for the fix.

(From yocto-docs rev: 4d63e1fc5786556dd0dd5ca1435252d43dbd745a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-18 23:50:46 +01:00
Scott Rifenbark
2996779354 ref-manual: Updated the INITRAMFS_IMAGE_BUNDLE variable description.
Fixes [YOCTO #10013]

I enhanced the description with more detail all around.

(From yocto-docs rev: 319dabecf5abf0884295b991f681bed0e1dbf673)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-18 23:50:46 +01:00
Scott Rifenbark
85ce753de6 ref-manual: Updates to INITRAMFS_IMAGE and INITRAMFS_FSTYPES
Fixes [YOCTO #10012]

Applied review comments.

(From yocto-docs rev: 1862d03c1916c34c29c1aea86fbb6ee4c7f34cca)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-18 23:50:45 +01:00
Scott Rifenbark
4fc256d145 ref-manual: Updated the INITRAMFS_FSTYPES variable.
Fixes [YOCTO #10012]

Added a new paragraph to the end explaining the default behavior.

(From yocto-docs rev: 1591f96fc04f64906145f272d205ec6c44ac70c0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-18 23:50:45 +01:00
Scott Rifenbark
ffdba3fafb ref-manual: Updated the INITRAMFS_IMAGE variable.
Fixes [YOCTO #10012]

Updated the description completely.  New more detailed information.

(From yocto-docs rev: cb6ce91674ab092324f97ca4e56a0cbcd9140fbe)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-18 23:50:45 +01:00
Scott Rifenbark
dfd845a126 ref-manual: Updated the PROVIDES variable description.
Added more information about virtual targets to the end of the
description.

Fixes [YOCTO #10011]

(From yocto-docs rev: ce7ae0c6ad4ad3a0c2422b797556563dc48a9a5b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-18 23:50:45 +01:00
Scott Rifenbark
5203cfe6a9 ref-manual: Removed redundant "and"
(From yocto-docs rev: 60a1b98e22d4118e090c0dd214736b78884da227)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-01 12:15:01 +01:00
Scott Rifenbark
2322267e24 ref-manual: Removed stray parenthesis.
Fixes [YOCTO #9988]

(From yocto-docs rev: 314f3c10e420a9681b4a814ddc4f24bbddd3741a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-01 12:15:01 +01:00
Scott Rifenbark
566ebc1af2 ref-manual: Updated the STAGING_DIR_HOST variable.
Fixes [YOCTO #9988]

Added a link to the MULTIMACH_HOST_SYS variable from the
STAGING_DIR_HOST variable where it is referenced.

(From yocto-docs rev: 0f72b58a7bc1271245d139726f1145d5d99acee4)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-01 12:15:01 +01:00
Scott Rifenbark
4396ffb3c9 ref-manual: Updated STAGING_DIR_TARGET and MULTIMACH* variables.
Fixes [YOCTO #9988]

Updated the STAGING_DIR_TARGET variable with a better introductory
sentence.

Updated the MULTIMACH_TARGET_SYS variable with a more expanded
explanation.

Added a new glossary entry for the MULTIMACH_HOST_SYS variable.

(From yocto-docs rev: d17873d695772b62325de35dd0e5b9ccc7f12f1a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-01 12:15:01 +01:00
Scott Rifenbark
05beac3ef0 ref-manual: Added a link to D variable and moved a task:
Fixes [YOCTO #9989]

Added a link to the WORKDIR term in the D glossary description
example.

Also, moved the do_checkpkg task from the section of showing
normal recipe build tasks to the the section for manually
called tasks.

(From yocto-docs rev: 548e2fdfeae9d67bbad73ee3ab69a64a9a6ce9ff)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-01 12:15:01 +01:00