Commit Graph

1720 Commits

Author SHA1 Message Date
Scott Rifenbark
f2db665b78 ref-manual: Updated the "poky" term
Applied some formatting and some links

(From yocto-docs rev: a0881588fcf2314b6d7bcbfb7ee9b9d4d7a2ef2c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:44 +01:00
Scott Rifenbark
fcb53beee4 documentation: Moved "Git" section to the ref-manual
Fixes [YOCTO #11630]

The "Git" section in the dev-manual is really about concepts.
There are a couple of examples that might or not might be
allowed to ultimately stay.  I have moved the section to the
ref-manual.  If those examples get replicated in the new
dev-manual, I will update the "Git" section further.  For now,
however, these remain in this moved section.

(From yocto-docs rev: 2e4b87fdab29c13ce0d2314e50c93e37404b6f7e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:44 +01:00
Scott Rifenbark
c7969c64bb dev-manual, ref-manual: Moved "Workflows" section to ref-manual
Fixes [YOCTO #11630]

I moved the "Workflows" section to the ref-manual.  This section is
primarily concepts and needs to be out of the dev-manual, which
is being reconstituted into a "how-to" manual.

(From yocto-docs rev: 2f8bfaac3da9e2d7042ea381a3e8957f96b5bf5a)

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
912d73d42b dev-manual, ref-manual: Moved "Licenses" section to ref-manual
Fixes [YOCTO #11630]

Moved the "Licenses" section from the dev-manual to the ref-manual.
The information in the section is purely reference material and
does not belong in the dev-manual, which is being reconstructed
as a "how-to" manual.

(From yocto-docs rev: a89cb18f6cab6702a2bf2a0f77d46e64f82b1729)

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
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
216ee69227 documentation: Moved "Yocto Project Source Repositories" section
Fixes [YOCTO #11630]

The "Yocto Project Source Repositories" section is purely conceptual
and thus does not belong in the reconstituted dev-manual, which is
converting to a "how-to" manual.  I have moved this section to the
ref-manual under "The Yocto Project Development Environment" section.

Moving the section affected several things.  Three figures that where
in the dev-manual were copied and moved to the figures folder of the
ref-manual.  This required deleting them from the dev-manual and
adding them to the ref-manual.

The makefile had to be edited to move those figures into the ref-manual
and delete them from the latest version of the dev-manual in order for
the tarball of files to be correct when the manuals are made.

Links to anchors within the moved section had to be fixed in various
manuals.  Links to the main section "id" had to be fixed to point
to the ref-manual manual.

(From yocto-docs rev: c619ae2bbc6be93cb0324ca44e936eefec12b28c)

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
12cc5f7ab2 ref-manual, dev-manual: Moved "Open Source Philosophy" to ref-manual.
Fixes [YOCTO #11630]

The "Open Source Philosophy" section that was in the dev-manual is
really conceptual reference information and has no place in the
dev-manual, which is being re-written to be a "how-to" manual. I
moved the section into the new "ref-development-environment.xml"
chapter.

No links were affected by this.

(From yocto-docs rev: 0a3e65bf7a23eec6e36a3cda3c2011b70aef325b)

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
de6d45fefc documentation: Re-org for "closer-look" chapter
Fixes [YOCTO #11630]

The ref-manual needs expansion for the old "closer-look" chapter.
This chapter previously held a detailed look at what happens when
a user uses the YP to develop something.  Now, the chapter needs
to also contain YP development environment concepts (e.g. open-
source philosophy, etc.), which are coming from the dev-manual.

Because of this, I renamed the "closer-look.xml" chapter to be
"ref-development-environment.xml".  I also renamed the larger
section that was formerly the entire chapter into its own section
named "Development Concepts".

Both these changes caused a few links to break.  I fixed all the
links from within the various manuals so they would find appropriate
targets.

I did some re-writing for introductory material to introduce the new
chapter and the section on "Development Concepts".

A new file ("ref-development-environment.xml") was added by basically
renaming the "closer-look.xml" chapter.  And, the tracking for
"closer-look.xml" was deleted.

(From yocto-docs rev: e37806474578b4f0ed137f64d68a39a17ab60644)

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
3f6a9af927 ref-manual: Re-organized the "Introduction" Chapter
I made some changes to better introduce this reference manual.
Clarified the best scenario for using the manual.  Removed the
long list of manual descriptions as that can be referenced further
down in the manual.

(From yocto-docs rev: 8f4555aa387ab3bd3f90f5fcda1d343811ecc168)

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
84d97de54a ref-manual: Removed the "id" for "layer" term - unused
(From yocto-docs rev: 6916dcb203425dd3b05dd0a05acc99a0bc00094e)

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
96b2eb0b6c ref-manual, sdk-manual: Fixed links for "cross-development-toolchain"
Fixes [YOCTO #11630]

Moving the "Yocto Project Terms" section from the dev-manual to the
ref-manual broke links for the "cross-development-toolchain" term.
I have fixed these.

(From yocto-docs rev: f2d2b5936bd339d691ab859cbe3df86e3da58f0c)

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
b8b87dd690 ref-manual: Fixed links in the "Yocto Project Terms" section.
Fixes [YOCTO #11630]

Moving the "Yocto Project Terms" section from the dev-manual to
the ref-manual caused many links local to that section to be
incorrect.  I scrubbed the section and fixed all the links.

(From yocto-docs rev: 4b795159aa80184f26ff1181a564516840c373b2)

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
45b16e35b6 documentation: Fixed links to "bitbake-term"
Fixes [YOCTO #11630]

Moving the "Yocto Project Terms" section from the dev-manual to
the ref-manual.  Doing so caused all the links to the id
"bitbake-term" to break.  These had to be individually fixed.

Discovered two unresolved references that were a consequence of
moving that section to the ref-manual.  These were fixed as well.

(From yocto-docs rev: 829ca6b64562f00a69f3956e9636c7edaa90ce16)

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
ed0ecc7b76 dev-manual, ref-manual: Reorganized "Other Information"
Fixes [YOCTO #11630]

The exhaustive list of useful links and references to other
YP documentation existed in the dev-manual.  This is not the correct
place for this type of reference information.  I have moved that
list to the ref-manual where it should be.  The dev-manual now
simply provides a link into that section.

(From yocto-docs rev: eeceb597988134ced85aab4b9ddaeed923f17b03)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14 10:19:25 +01:00
Scott Rifenbark
741dddf11a dev-manual, ref-manual: Reorganized Bugzilla information
Fixes [YOCTO #11630]

Reorganized the way the information about entering bugs using
Bugzilla is arranged in the documentation set.  The dev-manual now
has a section that is purely procedural and steps the user through
the process of logging a new bug in the Bugzilla system.  The
ref-manual has a conceptual section that introduces the YP
implementation of Bugzilla by simply telling the user what it is
and what what its purpose is.

(From yocto-docs rev: 4bfba345010be7bc2866b819b9754bb06f93c91f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14 10:19:25 +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
dce79d0efc ref-manual: Added warning to native.bbclass for naming convention
Fixes [YOCTO #11411]

Added a naming convention warning to the native.bbclass description
that is similar to the existing warning used in the description for
the nativesdk.bbclass.

(From yocto-docs rev: 2ceeb5416d439197e94640229e3685ab8b87e0fb)

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
374f3d6be2 Documentation: Created YP 2.4 "latest" docs
Updated poky.ent to use 2.4 variables and numbering

Updated mega-manual.sed to use "2.4" string for links

Updated all manual revision tables to use "2.4" and
"Usually October, 2017" string.

(From yocto-docs rev: 17ec7da6ab3fd450c2010812f7ad689288b12dcc)

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
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
Joshua Lock
4c68c5dac6 ref-manual: Fixed typo for "Installation"
(From yocto-docs rev: fbd983cda864174ac056cb4b9b54296d0f0c22e4)

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
f670640669 ref-manual: Removed section on checking for build-time dependencies.
This scheme has changed due to recipe-specific sysroots making it
obsolete.  Removed the entire section.

(From yocto-docs rev: c52a896829212863402e5532dd8fb7fe4c247fca)

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
0241215d3e ref-manual, dev-manual: replaced "depexp" with "taskexp"
(From yocto-docs rev: 3d7a13357a12b70d0c46b8aafdaf2ace20dcb970)

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
e801e6e7dd ref-manual: Removed text surrounding BB_SETSCENE_VERIFY_FUNCTION* vars
The BB_SETSCENE_VERIFY_FUNCTION2 variable no longer exists.  I removed
a link to the BB manual to this variable description, which no
longer exists.  Also, removed a paragraph in the discussion around
setscene that talked about the variable.

(From yocto-docs rev: 1f8e3d53ee72c369cb1211332e074976737fd76b)

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
bcf22c0bb6 dev-manual: Changed "Dnf" to "DNF" for consistency
(From yocto-docs rev: 22ca6c591fd28995a5444635dc787c67f8af822a)

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
bc1c16f616 ref-manual: Added links for variables
Needed to add cross-links into the glossary for various variables.

(From yocto-docs rev: 45acf78a2f99e8fda91042c2bee30094255e5a10)

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
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
7fdd0ac087 ref-manual: Applied 2.3 Migration review comments.
(From yocto-docs rev: 08a077adea37d5b3eb3ac119b1a5981a6fef21a3)

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
22f57cfbb1 ref-manual: Added warning for nativesdk recipe naming convention
Fixes [YOCTO #11411]

To help clear up the importance of the naming convention a user
must follow when creating a nativesdk-myrecipe.bb recipe that
inherits the nativesdk class, I placed a warning note at the end
of the section for the "nativesdk.bbclass" section.

(From yocto-docs rev: e6dc512aaeb0267c2c15c17a599c6950728b4547)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-04-29 11:17:52 +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
def638ebd6 poky.ent: Removed "python3-expect" package from 3 distros.
Fixes [YOCTO #11310]

After a bit of deliberation.. it was decided that
"python3-expect" is not needed in the Debian, Fedora,
and OpenSUSE distros as an essential package.  They are
gone.

(From yocto-docs rev: 07fcb23a03122e5f4f9bb2a32e585d9cba7d5d93)

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
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
7f47526f5c ref-manual: Initial draft of 2.3 migration section.
(From yocto-docs rev: c4c995aa94e5100e0d306eb91f490c23726ea91f)

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
43fefd1211 ref-manual: Added section on test and QA infrastructure
Fixes [YOCTO #10887]

There needed to be an overview of the test and QA infrastructure
used by the YP development team for releases and that is visible
to the developer.  I added a new section for this information into
the existing section on YP release processes.

(From yocto-docs rev: 17b3d6898b37bdbfbd23a333a4d659a9746696d0)

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
a51a7e9d87 ref-manual: Rewording of devtool-deploy target command caveats
Fixes [YOCTO #10350]

Based on Henry's assesment that the wording was unclear in some
spots, I did a little smithing to try and help.

(From yocto-docs rev: b52bb8d73071ad6b7a0956dec2f84a84ae1c7045)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-31 12:14:18 +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
646130271f ref-manual: Fixed wording for clarity
Fixes [YOCTO #10898]

I altered the verbiage used to describe the inclusive nature of
the beginline and endline note to be clear to non-native English
speaker based on feedback.

(From yocto-docs rev: 5edf417cd044ded30d1f8366ac0cde336d0da016)

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
af4ef8adbc ref-manual, yocto-project-qs, poky.ent: Fixed CentOS essentials
Fixes [YOCTO #10854]

I added extra "yum" commands and a make command to deal with
some essential packages needed for CentOS distribution.  These
packages were missing.

(From yocto-docs rev: 38ac6cf0165f7dd7bbfd583e218b6948dafae29c)

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
b3e2ecaae2 documentation: Added support for "pyro" name and May release date.
poky.ent - changed the "tbd" and "TBD" strings to "pyro" and
           "Pyro", respectively.

Manual Head Files - Updated the manual history table with the
           May release month.

(From yocto-docs rev: 076226d2986d0cf69685121e4342f50c1603fc7b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-24 23:44:03 +00:00
Scott Rifenbark
c94501d5ae ref-manual: Updated note about included failed license check
Fixes [YOCTO #10898]

It is hard to get the exact start and end for included license text
during a LIC_FILES_CHKSUM operation.  I updated the notes indicating
that the QA message returned upon failure includes the attempted
license text.  The user can better adjust his LIC_FILES_CHKSUM
statement to then dig out the proper text.

(From yocto-docs rev: 1db04334703f35f1cab933c345fb1db43fd0af79)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-24 23:44:03 +00: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
478c7c3043 ref-manual: Added information about pre-installed dependencies
Fixes [YOCTO #10350]

A situation exists where a user deploys a new application using
devtool target-deploy and the new application has runtime dependencies
that are not already on the target.  When this situation exists, the
application misbehaves if it calls a missing function.  I added the
explanation of this situation to the section that describes the
devtool deploy-target command.  Also, put a pointer in the section
on devtool add for cross-reference purposes.

(From yocto-docs rev: 694151e397ff40871b3ec8700c39d32a15814535)

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
4c1432bd0b ref-manual: Added new "Release Process" chapter
Fixes [YOCTO #10888]

The YP documentation was missing information on how the major
and minor (point) release process works.  I added a new chapter
in front of the "Maintenance" chapter that details the naming
schemes, cadence, and maintenance for YP releases.

(From yocto-docs rev: b486f871e1fb8a6f763510ed385f459fe215fa27)

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
27a9c9d788 ref-manual: Expanded kernel task descriptions.
Fixes [YOCTO #9376]

Expanded many of the brief descriptions for the kernel-related
tasks.

(From yocto-docs rev: ee9e54aa9f148e5438cd9bdf7e55d7fa43cc3ec5)

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
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
77afd14e81 documentation: Updated "latest manual" note on title page
Fixes [YOCTO #10076]

The note on the title page for each manual was brief regarding
where to find the latest version of the manual.  I updated the
note to have more detailed information on finding current,
alternate, and latest versions of the manual based on YP
releases.

(From yocto-docs rev: 0ec81465296a7a78309d3039af4d00caa52d2285)

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
aa7e2717d3 ref-manual: remove core-image-directfb reference
core-image-directfb was removed from oe-core with this commit:

remove core-image-directfb.bb as part of moving directfb
from oe-core
(From OE-Core rev: 8871fe1189776d78e5848b08edb9c990b9aebf2d)

I made the similar change to the ref-manual by removing it
from the "Images" chapter.

(From yocto-docs rev: bee62aea8469cfca77e6f5e97a9ef2f52f16c9cb)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-01-25 12:07:43 +00:00
Scott Rifenbark
76bff7e67a ref-manual: Removed package-depends.dot and pn-depends.dot
The generated package-depends.dot and pn-depends.dot stuff
contains partial data about the taskgraph and tends to
confuse users.  Richard Purdie suggested removing these from
bitbake/lib/bb/cooker.py.  I have removed the references to
them in the "Viewing Dependencies Between Recipes and Tasks"
section of the ref-manual.

(From yocto-docs rev: 3dc9b124532b52369cec2de8209f33aebce2b648)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-01-25 12:07:43 +00:00
Scott Rifenbark
f4b667cfbc ref-manual: Updated LIC_FILES_CHKSUM example
Fixes [YOCTO #10898]

No information indicated the use of "endline" and "beginline"
in the examples setting LIC_FILES_CHKSUM.  I added a note
indicating that line numbering starts with one and the "endline"
value is inclusive.

(From yocto-docs rev: 21114f09efa423033da67af1f27c99eb3cb9695d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-01-20 11:57:25 +00:00
Scott Rifenbark
81021bc0aa yocto-project-qs, ref-manual: Added note for "resources temporarily unavailable" error
Fixes [YOCTO #10818]

There is a weird and intermittant error that can occur on any given
distribution that has a 4.3+ Linux kernel and a version 228+ systemd.
The error happens during an initial build of an image and indicates
that resources are unavailable.  Investigation determines that
resources are available.  The combination of the kernel and the
systemd in a distro is causing issues when a distro is upgraded.

yocto-project-qs:
I added a note in the two areas where the user is stepped through
the bitbake process to build an image.  The note mentions the
possibility of the error, the host configuration situation, and a
couple work-arounds, which are to reboot the machine or to set the
"DefaultTaskMax" systemd parameter to "infinity".

ref-manual:
Added the same note in the "Building an Image" section.

(From yocto-docs rev: 3516803f9e6b5a29e4f95d31742c6e03ff63ef41)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-01-11 17:23:18 +00: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
4775af4650 ref-manual: Added KERNEL_IMAGE_BASE_NAME change to 2.2 migration
The fact that the OpenEmbedded build system can now build
multiple image types caused the KERNEL_IMAGE_BASE_NAME variable
to have the KERNEL_IMAGETYPE portion removed.  This could cause
existing recipes that use the KERNEL_IMAGE_BASE_NAME variable
directly issues.  I added a section indicating that the user
should address those recipes to avoid problems.

(From yocto-docs rev: c433fca3840440c14bb364a51afc5c3c2bfc7c88)

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
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
6ce2cdcc93 documentation: Updates to support developing 2.3 YP docs
Changes to the following:

 * All manual revision tables to indicate a 2.3 release proposed
   for April of 2017.

 * Updated the poky.ent file so that all variables needed reflect
   2.3 values.

 * Updated the mega-manual.sed file so that processing of links in
   the mega-manual work for a 2.3 release.

(From yocto-docs rev: 926e282c17b67c79b94a0b62a0b18bfbe0b26c40)

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
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
78aa906c2e ref-manual: Added api-documentation to distro features
Fixes [YOCTO #8584]

Updated the "Distro Features" section to include the
"api-documentation" feature.

(From yocto-docs rev: 5b4e8fc58b84aea9a940f67f8d7585912fadc676)

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
2759976f48 ref-manual: Fixed presentation of "openSUSE" in supported distros
The way I had this string was incorrect.  I changed it to "openSUSE".

(From yocto-docs rev: 221f5032ad3589b96a004d38e2b250e38f971007)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-11-16 10:38:41 +00:00
Scott Rifenbark
9ca2c30cb4 ref-manual: Updated the supported distro list for Morty.
(From yocto-docs rev: 0891a9a5715b00de7bd872a7df6f84ef2ea441eb)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-11-16 10:38:41 +00:00
Scott Rifenbark
b70c6c590e ref-manual: Fixed tense issue for migration 2.2 section
The "runqemu Ported to Python" section was using past tense
for a note about previous usage patterns being supported.  I
changed this to present tense.

(From yocto-docs rev: d8956022c7eb6046e67766fd6e9121579d6b323b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-11-16 10:38:41 +00:00
Scott Rifenbark
69e8c1a888 ref-manual: Removed host package requirements for SDK
These requirements were in place for the ADT, which is gone now.
I have removed the four supported host lists for packages to
support the SDK.

(From yocto-docs rev: 9c7c20074e455c24c3fa4cf7114495af47d9881c)

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
e0ed9253c1 ref-manual: Applied minor corrections to 2.2 migration section.
Moved a couple notes around and changed some wordings...
nothing major.

(From yocto-docs rev: 75be6c30ca646ee81b955fae7a3e0183ead9ca08)

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
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
3769f7ba06 ref-manual: Updated 2.2 migration for runqemu porting to python
Indicated that the configuration file is not mandatory.  Also,
documented the supported qemu* machines should you run the
script without a configuration file.

(From yocto-docs rev: aeb2c28d7476f67302a1b51da51fb57027e9d02c)

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
b6eef6520b ref-manual: Added more to migration 2.2 runqemu ported to python.
Provided more detail on what the user can do with configuration files
to use the changed runqemu.

(From yocto-docs rev: 5dee8ceca290fdc8f3b41e0eba6565494190ce4f)

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
f9ea0a8770 ref-manual: Updated the 2.2 Migration section with review changes.
(From yocto-docs rev: 4af78f942bedb55e46280bc0fc878f174e15b479)

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
Scott Rifenbark
d669b83797 ref-manual: Added links for migration BitBake change.
I did not put in the links for a couple commits for some of the
2.2 bitbake changes.  Put in the links.

(From yocto-docs rev: a806463a07ab07ce9da23d6bb73cb981b85b668e)

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
Scott Rifenbark
3a5b86e0ed ref-manual: Fixed missing title for migration section.
(From yocto-docs rev: 81645a11c4e27daa30891265e9a1ea2c3c2682cc)

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
Scott Rifenbark
a6752eb2a4 ref-manual: Added the 2.2 Migration guide section.
(From yocto-docs rev: 668e32419ba59d975a196967e620c384009426a4)

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
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
Scott Rifenbark
97ac70175f ref-manual: Changed BB_SETSCENE_VERIFY_FUNCTION name
The BB_SETSCENE_VERIFY_FUNCTION variable has effectively changed
names to be BB_SETSCENE_VERIFY_FUNCTION2.  I made the one instance
of it correct here.

(From yocto-docs rev: c2864dace370d7a43234f4728b33f25082e628e3)

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
d31a826120 ref-manual: Updated the do_sysroot_populate task description.
Fixes [YOCTO #10377]

Added more detail and linked it to key variables.

(From yocto-docs rev: d82c1d4e8cc95bee718388cfeced1566ce8569a0)

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
1053502cf0 ref-manual: Updated QA error message.
Added wording to the "installed-vs-shipped" error message
in the QA chapter.

(From yocto-docs rev: cc9d22fb6dd8e45ef6b53608f0ebccf29721cc3f)

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
3b4987a32b ref-manual: Added note about bb.fatal() raising an exception.
Fixes [YOCTO #10363]

Added a small note to the bullet item about bb.fatal().  Noted
that the function raises an exception so the user does not
have to put a "return" statement after the function call.

(From yocto-docs rev: c27bae87192b7e109d995679c8c91fb3388d8d4c)

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
b1e4d96e28 documentation: Updated Manual revision table for 2.2
Added string "October 2016" as the release date.

(From yocto-docs rev: db40986677746afbbb138d9cbe3885111550b7c5)

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
aaeb1ee90b ref-manual: Added a reference to viewing task variable dependencies.
Put a closing reference in the "Stamp Files and the Rerunning of Tasks"
section to point the user to the area that tells them how to
view information about a task's signature.

(From yocto-docs rev: 3f395ef1999a2aff1447da4d257fd5d53124aaa7)

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
ca85107b9a ref-manual: Updated build/tmp/cache/ reference section
Fixes [YOCTO #10356]

Expanded the general description of this directory.

(From yocto-docs rev: df71fe472f9d5cb5f809706ec4218952a49d31d3)

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
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
c2c052e34a ref-manual: Added explanation of the -C option
Fixes [YOCTO #10345]

There was no mention of the -C option in the "Running Specific
Tasks" section.  I added information to cover this command-line
option.

(From yocto-docs rev: 7b05c5dd3816414c1d3ca898fbd41ce588425057)

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
bbc7a646ec ref-manual, dev-manual: Add information on devpyshell
Fixes [YOCTO #9166]

In the dev-manual, I added a new section titled "Using a
Development Python Shell."  This section is similar to the
section that talks about using devshell.  The section is
tied to a reference section on the do_devpyshell task.

In the ref-manual, I entered a new task reference for the
do_devpyshell task.  It is brief and references into the
new section in the dev-manual.

(From yocto-docs rev: 637128809e298c3d5e660f6da2366f8e9e307218)

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
f1b31e9ea5 ref-manual: Updated the intro to the devtool quick reference.
(From yocto-docs rev: cb2c4adc48e723072550de0c1ff1f61201c9e8a6)

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
58b1381231 ref-manual: Fixed a typo.
(From yocto-docs rev: ee94b0741b0cd6512adb6b2668413341c8d451e9)

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
13d47a1fa5 ref-manual: Added two new tips
Fixes [YOCTO #10297]

Updated the "Other Tips" section to include a couple new tips.

 * Remove the /tmp directory as a way to work-around temporary
   build issues.

 * Create a little method to help you search the massive
   amounts of bits for whatever.  Also, suggested filing bugs
   against the docs if a feature is too hard to find or figure out.

(From yocto-docs rev: d9829dd096f7cc56f8e55fba3190be2a59b80fe5)

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
ad539f5c15 ref-manual: Added 'depchains' description for auto dep. mech.
Fixes [YOCTO #10295]

Added a third item to the list of mechanisms in the
"Automatically Added Runtime Dependencies" section.  The new
mechanism is depchains.

(From yocto-docs rev: 304fe159bfbd426b8b42e1245db83ee57b9e5588)

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
89621b137e ref-manual: Updated "Viewing Variable Values" section.
Fixes [YOCTO #10292]

I added an additional paragraph at the end of the section that
provided more detail on what the bitbake -e and bitbake -e recipe
commands provide in the way output.

(From yocto-docs rev: 1dcdb6781105f046328271e2b4ba7d875b222dcf)

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
4404fc3fe0 ref-manual: Provided an introductory text to the devtool ref.
I put in some introductory material for the new devtool
quick reference chapter.

(From yocto-docs rev: dc46f47692a533ac2450bf459c098435c57e6c07)

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
ed6a5495a1 documentation: devtool upgrade and quick ref changes to mult manuals
Did the following:

 * Added the devtool upgrade flow to the SDK manual.
 * Removed the devtool Quick Reference from the dev-manual and
   added it as a new chapter to the ref-manual.
 * Made sure all the links and cross-references work now with the
   moved material.
 * Updated the Make file so that the manual set builds correctly
   regarding the new chapter in the ref-manual.
 * Created cross-referencing notes in both the sdk-manual and the
   dev-manual to the newly located devtool Quick Reference chapter.

(From yocto-docs rev: fda0bf68b3654b1b96407d552c5254657465b5fc)

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
899ea9cb48 ref-manual: Another edit to the oe-pkgdata-utils description
Fixed the description to match that what is in the code.

(From yocto-docs rev: c099dd0b7c8d205b56009606e61ae359017f5783)

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
b247baeff2 ref-manual: More wording changes to oe-pkgdata-util section.
(From yocto-docs rev: 63f412dd31ae05dd0abdcc2b97b1c596b6054f18)

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
79cb2ed033 ref-manual: Applied some re-writes to oe-pkgdata-util use section.
(From yocto-docs rev: 40175a3e120fd57fcd03fdfd19c84ffd8336595d)

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
8c2172b8be ref-manual: New section on using oe-pkgdata-util
Fixes [YOCTO #10216]

Creted a new section titled "Viewing Package Information with
oe-pkgdata-util".  This section describes how to view information
for already build packages through the use of the
oi-pkgdata-util command.

(From yocto-docs rev: 8d9465f320f973ecaeecb3eae594b29c0d7f4960)

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
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
8a3d542d5c ref-manual: Fixed typo for "debugging".
(From yocto-docs rev: a8a3bdc0bcec938486f533148fc3f6d106e5af94)

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
77dee668ba ref-manual: Changed command to install Fedora Python package
Fixes [YOCTO #10208]

The example command was wrong.  Had the wrong package name since
we moved upward with Python.  Using "sudo dnf install python3-GitPython"
now.

(From yocto-docs rev: d94469ac4860841c3955161ce1b67a962c4f3f8d)

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
d4cd787e08 yocto-project-qs, ref-manual: Removed Python 3.0 exclusion
Fixes [YOCTO #10178]

Previously, YP did not support Python 3.0.  We mentioned that
in the manual in several places as a requirement for running YP.
I removed this exclusion in the following areas:

 * yocto-project-qs - the section that tells what version of
   Python you need.

 * ref-manual - the section that tells what version of Python
   you need.

 * ref-manual - the FAQ entry about not having the right version
   of Python.

(From yocto-docs rev: 5a0d3ac1c2a4154b93dc925b8074bc9243a86faf)

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
9f0e068baa ref-manual: Grammar fix in "Stamp Files and the Rerunning of Tasks"
(From yocto-docs rev: 0d04e8c226ff9391e14f5b07ee95de4e4b7d3bcf)

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
3b70c96537 ref-manual: Replaced "bitbake-dumpsigs" with "bitbake-dumpsig".
Fixes [YOCTO #10141]

(From yocto-docs rev: e74a66d146e7f666a71f2dab6a5f78de5ad1966c)

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
ac0fa7a296 ref-manual: Added bitbake.conf to list of example conf files
Fixes [YOCTO #10144]

In the "Viewing Variable Names" section, there is a list of
example configuration files.  I added bitbake.conf to the list.

(From yocto-docs rev: 5a19d5c314881e223aaa567c8eb8f6ed4fbc01df)

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
1769e1a2de ref-manual: Suggested fleshing out of the sigdata/siginfo documentation
Fixes [YOCTO #10141]

Provided several fixes to address this situation:

 * Renamed "Debugging Build Failures" to "Debugging Tools and
   Techniques" as it fit better the subsections.

 * Renamed "Viewing Dependencies" to "Viewing Dependencies
   Between Recipes and Tasks" as it fit better the description.

 * Added a new "Viewing Task Variable Dependencies" section
   to describe how sigdata and siginfo stuff can be used.

 * Replaced the contents of "4.3.4.1 Debugging" with a shorter
   bit that now references into the new section on veiwing
   task variable dependencies.

(From yocto-docs rev: 539d76366055bed74ccc926519e969324cac470d)

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
Maxin B. John
c66683671e ref-manual: swabber: remove from documentation
Remove documentation as swabber was removed from oe-core with
this commit: commit a7ddbea345

(From yocto-docs rev: f3c462b2c6aa20de53c77e5d93cf397ae36cb2bb)

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
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
f1d2a932f6 ref-manual: Applied review edits to "Viewing Dependencies"
Fixes [YOCTO #10131]

Fixed some small issues here and there.  Also, provided a
second itemized item in the note box turning it into a
notes box.

(From yocto-docs rev: a736c3bb707e81eda7760c642084a5a7c4de2539)

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
b249c8d2d5 ref-manual: Removed the "pid" stuff from viewing failed tasks
Fixes [YOCTO #10132]

My attempt to be complete on the filenames that have a "pid"
portion were not correct.  I have removed them from the first
paragraph.

(From yocto-docs rev: 8261b93b39df9abc9f9d6ccb4c00dc11330ad516)

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
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
f82a65776b ref-manual: Updated the "Viewing Logs from Failed Tasks" section.
Fixes [YOCTO #10132]

Provided a better description and removed a deprecated sentence
near the end.

(From yocto-docs rev: bbe588e19bb9ed58883ae7c770da551de659e982)

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
3db5ff6386 ref-manual: Updated the section on viewing dependencies
Fixes [YOCTO #10131]

The section was renamed "Viewing Dependencies" for consistency.
The section was moved up to be the third item in the sub-section
list.  The section was extensively re-written to provide more
clarity and options for the user to view dependencies.

(From yocto-docs rev: d521c3aabe6ded105cde6f7b3563c85340f759fd)

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
1a1fc42e9f ref-manual: Clarify and flesh out debugging using bitbake -e
Fixes [YOCTO #10099]

Renamed the log file section to better describe what the user
is accomplishing.

Renamed and repositioned the variables section to better describe
and emphasize the task.  Also fleshed out the variables section with
more information.

(From yocto-docs rev: 0606fe481416a07bf98fc8ae79a30c1d62e75e6d)

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
31b06fe353 ref-manual: Updated the do_compile task section.
Fixes [YOCTO #9964]

There was a small fix to change oe_runmake task to oe_runmake
function.

(From yocto-docs rev: aa049c9165c67e041c84fab9fabfbe98828c79bb)

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
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
Scott Rifenbark
376a8201d1 ref-manual: Augmented some STAGING_DIR_* variable descriptions:
* Updated the STAGING_DIR_HOST description
 * Updated the STAGING_DIR_NATIVE description
 * Updated the STAGING_DIR_TARGET description

Fixes [YOCTO #9988]

(From yocto-docs rev: cc2c3d849f0919199d1b7960e30ed152f3f0474e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-01 12:15:00 +01:00
Scott Rifenbark
599be67eef Revert "ref-manual: Added new glossary entry for REMOVE_PKG_SUPPORT."
This reverts commit 95b740d719a7a6ffe3a06a1f152af4d877ee08c7.

I inadvertantly put this variable description in before they had
settled on it.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-01 12:15:00 +01:00
Scott Rifenbark
33b01c502f ref-manual: Added 3 new QA sanity checks.
Fixes [YOCTO #9983]

Added the host-user-contaminated, invalid-chars, and invalid-packageconfig
QA checks.

(From yocto-docs rev: 5bd28f9386a8afff435254788fbce73a7fc48305)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-01 12:15:00 +01:00
Scott Rifenbark
f2fa3c59bb ref-manual: Applied review edits to "Checking for Missing Build-Time Dependencies"
Removed an errant comma and rewrote the final area of the section.

Fixes [YOCTO #9976]

(From yocto-docs rev: 19924dee2ebec3ff2a53152ecb8f79172eb43060)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-01 12:15:00 +01:00
Scott Rifenbark
7c5a147141 ref-manual: Applied review changes to the do_deploy task.
Cleared up the last third of the description with better structure
and wording.

Fixes [YOCTO #9970]

(From yocto-docs rev: a2dbea4f3bbdddd72c86a5ade86ac822cd9bfecd)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-01 12:15:00 +01:00
Scott Rifenbark
c9e3815b2e ref-manual: Added new "Checking for Missing Build-Time Dependencies" section.
I added a new suggest section to the existing "Debugging Build
Failures" section.  This section describes how to check for
build-time dependencies.

Fixes [YOCTO #9976]

(From yocto-docs rev: 54cd7161593ba35b63a26ade312cc4aee17e3515)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-01 12:15:00 +01:00
Scott Rifenbark
fa0c574deb ref-manual: Added link to the do_populate_sysroot task
Fixes [YOCTO #9968]

Made a link for the STAGING_DIR_HOST variable for consistency.

(From yocto-docs rev: eeb163ead40752d69f2f6c19e859e82109ef967d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-01 12:15:00 +01:00
Scott Rifenbark
6c302a4250 ref-manual: Applied formatting to QA check string in do_install task
Fixes [YOCTO #9966]

(From yocto-docs rev: ae87d07c8d429813d30569360eb4889eac398bee)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-01 12:15:00 +01:00
Scott Rifenbark
38c33b7904 ref-manual: Fixed output example in the B variable.
Updated the example statement line to match the actual assignment.

(From yocto-docs rev: 45e9274fcca0a285bda38cad8a6fe5e7bb05bd80)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-01 12:15:00 +01:00
Scott Rifenbark
30929cf037 ref-manual: Updated the do_deploy task reference section.
Fixes [YOCTO #9970]

Added more detail to the do_deploy task.

(From yocto-docs rev: 1b2daf814011dbc3c5987313442e95e18e83e180)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-01 12:14:59 +01:00
Scott Rifenbark
bc14368d39 ref-manual: Added detail to the populate_sysroot task.
Provided more detail in the first sentence.

Fixes [YOCTO #9968]

(From yocto-docs rev: 15080a565bafdfffe0c13a0a18fd1c011773cc25)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-01 12:14:59 +01:00
Scott Rifenbark
bb1643444e ref-manual: Updated the do_packages task.
Fixes [YOCTO #9967]

Added more detail to this task description.

(From yocto-docs rev: 8cb154493a6b4ee541826f898b823a4dc2795f88)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-01 12:14:59 +01:00
Scott Rifenbark
4f27aa6e3a ref-manual: Updated the do_install reference section.
Fixes [YOCTO #9966]

Added quite a bit of detail to this task's description.

(From yocto-docs rev: c29d86813b9cb9bc1c9c02aeffb5cfd99fc5a542)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-01 12:14:59 +01:00
Scott Rifenbark
781bff802b ref-manual: Updated the do_configure task.
Added more detail for this task.

Fixes [YOCTO #9965]

(From yocto-docs rev: e50207488b8262bb46e58c4b9f40e487c15abc67)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-01 12:14:59 +01:00
Scott Rifenbark
8f2d8c2061 ref-manual: Fleshed out the do_compile task.
Fixes [YOCTO #9964]

Added more detailed information to the do_compile task.  Also, provided
some information about oe_runmake in the base.bbclass refrence.
Finally, put some detail in the "Shared State" section concerning
do_deploy[dirs].

(From yocto-docs rev: 5d0612a57cc8e035a2194ada21e65055ef2b8a2e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-01 12:14:59 +01:00
Scott Rifenbark
04c611290c ref-manual: Updated RDEPENDS variable description with note.
Fixes [YOCTO #9963]

I created a new cautionary note to warn the user to use the correct
operator "+=" rather than "=" so that they do not destroy $PN.

(From yocto-docs rev: e6861ffe9400b1ee48cc46ccfc6e8d65efbbec8c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-01 12:14:59 +01:00
Scott Rifenbark
818e439cf5 ref-manual: Applied review comments to logging mechanism section
Fixes [YOCTO #9950]

I Provided a suggested introductory sentence and a better link to
the logging.class file, which is near the end.

(From yocto-docs rev: 6f296266b35f17792510d6a01f5640ba30818a22)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-01 12:14:59 +01:00
Scott Rifenbark
aae4c2a629 ref-manual: Updated the "Recipe Logging Mechanisms" section
Fixes [YOCTO #9950]

Added more detail on the functions for logging.

(From yocto-docs rev: b7ed4d84ae5221765201fe661af3741fb01da738)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-19 15:04:52 +01:00
Scott Rifenbark
451334a841 ref-manual: Applied review changes to the DEPENDS variable.
Updated the note with some formatting and grammar changes.

Fixes [YOCTO #9933]

(From yocto-docs rev: afef28ae894c313f85ddbaeef8b0abbc2700ba2c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-19 15:04:52 +01:00
Scott Rifenbark
bdf9003cfb ref-manual: Added review changes to BBCLASSEXTEND description
Fixes [YOCTO #9909]

Added some technical clarifications to the existing note to be clear
about what is causing the limitations in this case.  Applied some
formatting fixed to for the use of the include word.

(From yocto-docs rev: cbbd960d8665d9fb6b92698c14728d1c0bcc659f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-19 15:04:51 +01:00
Scott Rifenbark
acdfb5f3cc ref-manual: Added notes to the DEPENDS variable description.
Fixes [YOCTO #9933]

Added two notes to help clarify how DEPENDS works with pre-compiled
objects.  There are some details that trip people up.

(From yocto-docs rev: 06917e97adf24816b0aee6fdfdd14aa79d4c6ab2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-19 15:04:51 +01:00
Scott Rifenbark
640181cce8 ref-manual: Added clarifying note to the BBCLASSEXTEND variable.
Fixes [YOCTO #9909]

Added a note that talks about how the BBCLASSEXTEND mechanism
adds recipe variants.

(From yocto-docs rev: a05990ecb760519a685a1c5ddcf2ce3e048bfbf2)

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