Commit Graph

1912 Commits

Author SHA1 Message Date
Scott Rifenbark
d9ead424c5 ref-manual: Updated "Build System" term to "Build Host"
(From yocto-docs rev: 2f5b8678e3c4b791a8cdfe5e75da706b97fbc753)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:31 +00:00
Scott Rifenbark
30335a6269 ref-manual: Updated comprehensive list of manuals etc.
I added the concepts manual, the ref manual, and the mega-
manual to the list.

(From yocto-docs rev: 180387ac9ae74cd5b69c4cf6338b72daef4b9f37)

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

(From yocto-docs rev: 30f2bc46be4a0faf5302eb8605bcb29f3bee6cf3)

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

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

(From yocto-docs rev: fca1c56b0764802fb6a687ea81ab0fb95186cf0a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:30 +00:00
Kristi Rifenbark
12a68f02bc dev-manual, ref-manual: Updated references to Bugzilla wiki page
Fixes [YOCTO #12475]

(From yocto-docs rev: 460660fda7433959cff13897ece4a6c9f7ff8d09)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:30 +00:00
Kristi Rifenbark
a661287da3 ref-manual: Reformatted Note to use bullets
(From yocto-docs rev: 2aa21e54b620c147ea6db9dee206e40800d7d34c)

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

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

(From yocto-docs rev: 6c7abf9192390121000f577d6c98f259d290d15d)

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

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

(From yocto-docs rev: 44d2889a4f3fb5dfabb1ea4df68a1b8bbf9347c8)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:29 +00:00
Scott Rifenbark
30b91e6d89 documentation: Removed "usingpoky" chapter from ref-manual
Fixes [YOCTO #12370]

All of the information from the "usingpoky" chapter in the
ref-manual has been distributed out over the rest of the
YP manual set.  Primarily, this information went into the
dev-manual and the overview-manual.  Because the chapter is
no more, I had to update the mega-manual.xml to not include that
chapter. Also, had to update ref-manual to exclude the chapter
as part of the Make process.

(From yocto-docs rev: b988cab06d42f0ac2220cefe66949c5ab6cbf803)

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

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

(From yocto-docs rev: 9634bd8dc51e2972e6a5f3a3d3b4256c8ca8749c)

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

The QEMU information in the ref-manual "using" chapter has been moved
to the dev-manual's chapter 5, which is a dedicated QEMU chapter.
Some information is reference and that is why I had it separated out
into the reference manual.  However, pressures are mounting to get
that stuff out of the ref-manual and into the dev-manual.  So, it
has been moved.

(From yocto-docs rev: 69098ad83b10fab341ec3d5532e377dcfbbfc05e)

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

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

(From yocto-docs rev: 95394197fc04981bf7571e581ff8a0fd9c76223f)

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

The section in the ref-manual that overviewed the buld process was
redundant and more of a "how-to" topic.  I have moved and merged it
into the dev-manual into a similar area.

(From yocto-docs rev: 44f1351334342629aaa0976f62e64ac4f67166aa)

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

Grammar scrub of variable definitions in documentation.conf

(From yocto-docs rev: 199fdc55aae4f34d95988ee2e43f3524fe82714a)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:29 +00:00
Kristi Rifenbark
635bec34d0 ref-manual, yocto-project-qs: Removed 6.x CentOS Notes
(From yocto-docs rev: 0a553dabddd4cd11ec37339822072bd7bb674dab)

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

Grammar scrub on all variable description for documentation.conf

(From yocto-docs rev: 3054b1e4649d232f08f1065bad96b90eed57d517)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:28 +00:00
Scott Rifenbark
a0c5167103 ref-manual: Added overview-manual to list of related documentation
(From yocto-docs rev: f0b296e8623078d7d4df45984ebdcdf9f1b65062)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:28 +00:00
Scott Rifenbark
9b4575b508 ref-manual: Removed the "technical-details.xml" file
Fixes [YOCTO #12370]

The "technical-details.xml" file was for the old chapter four of the
ref-manual.  All content in that chapter has been moved to the new
concepts chapter of the overview-manual.  I updated the mega-manual.xml
file to not include the old technical-details chapter as part of the
ref-manual.  I also updated the ref-manual.xml file to not include the
technical-details.xml chapter when building the ref-manual.

(From yocto-docs rev: c4a88048dc099dbd2d0926a9194d5502fa2f1cfc)

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

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

(From yocto-docs rev: 34c013f055736dcde2fe12daea1aaf2beaee97c5)

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

The "Wayland" section needed to be moved to the concpets chapter in the
new overview-manual.  I moved it and fixed a few links that needed
adjusting due to the move.

(From yocto-docs rev: b8e84a8cb47194b0d20fe155561d9a346916068b)

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

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

(From yocto-docs rev: df2c09407abd5ca468fcd0bd9e241739907a9d63)

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

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

(From yocto-docs rev: fa3e12030ce867cb81feed453d35c3a3643decd2)

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

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

(From yocto-docs rev: 1c4e5207bdde19d4b48ef42b1de81390d8a02d64)

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

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

(From yocto-docs rev: 1f3ee5ab308cbe6bd7194086026db397b67ca7c4)

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

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

(From yocto-docs rev: 75ced485bb223373591eb41d1b343d0c2b315345)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:27 +00:00
Scott Rifenbark
8097a978ce dev-manual, ref-manual: Moved Wic Plug-In section to dev-manual
Fixes [YOCTO #12370]

I had a section on Wick Plug-Ins in the ref-manual in the
"technical details" chapter.  This section has been combined with the
section on using Wic that lives in the dev-manual.  This move creates
a single section on using Wic to create Wic-partitioned images.

The section was moved out of the ref-manual and merged into the
dev-manual Wic section.

(From yocto-docs rev: 8724049141c9a793312dcf5ff5c3425948d1cbd0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:27 +00:00
Scott Rifenbark
e2060287db overview-manual, ref-manual, dev-manual: Moved x32 stuff
Fixes [YOCTO #12370]

The section on the x32 psABI topic was in the "technical details"
section of the reference manual.  This section combined conceptual
and "how to" information for x32 psABI.  I moved the conceptual
information to a new chapter in the overview-manual.  I moved the
"how-to" information to a separate topic in the dev-manual.  This
resulted in the mega-manual being updated to take on a new chapter
for the overview-manual (overview-concepts.xml).  No links were
affected.

(From yocto-docs rev: 84da28a4ad0f3f89bfc865f410a5d06b57439beb)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:27 +00:00
Scott Rifenbark
60cfd0785b ref-manual: Separated terms into separate chapter
Pulling out some introductory information from the old "Introduction"
chapter of the ref-manual has isolated the system requirements and
term definitions sections.  I have decided to create a new chapter
for terms as they are a reference item.  This leaves system requirements
also alone as a new chapter.  So, I dumped the introduction.xml chapter
in favor of the two new chapters.

(From yocto-docs rev: 35c41b3008845c94e10be19b37409b0d1a469ff5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:27 +00:00
Scott Rifenbark
c06a654c1d overview-manual, ref-manual: Moved introductory material to overview manual
Fixes [YOCTO #12370]

Moved an introductory section for YP that was in the ref-manual
to the beginning of the YP environment chapter of the overview-manual.
Had to move a figure and update the makefile as well as adjust some
links.

(From yocto-docs rev: 8ec45f945a21b1f64e7529b95df6b5fb21e87449)

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

(From yocto-docs rev: 05e20792fa6c93618499f06adfa2d4b82f24275a)

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

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

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

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

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

(From yocto-docs rev: 87b81358f2bbd02b4a0d966d86c4d7b006d4d78f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:27 +00:00
Scott Rifenbark
9f478d1358 dev-manual, ref-manual: Moved source file sections
The sections in the introductory chapter of the ref-manual are better
served as part of the dev-manual.  These sections are about accessing
YP source files using various methods (i.e. source repositories,
index of releases, and nightly builds).  I have integrated that
information into the dev-manual where the information was also being
treated.

(From yocto-docs rev: d3a97b1f9367d5bb5370974c8c5c0404df86724a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:27 +00:00
Kristi Rifenbark
8240adb06b ref-manual: Applied review edits to openSUSE Packages
Fixes [YOCTO #11911]

(From yocto-docs rev: 1f154a1496a9ae3f28453242131d55aa8d267650)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-22 22:23:06 +00:00
Kristi Rifenbark
c1e0242aaa ref-manual: Added BBFILES_DYNAMIC variable to glossary
FIXED [YOCTO #12089]

(From yocto-docs rev: 0906e9080e1c150feab60bb9d095688d274a061e)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-22 22:23:06 +00:00
Kristi Rifenbark
52586b4102 ref-manual: Added Note to CentOS For Wicked
FIXED [YOCTO #11911]

(From yocto-docs rev: 99eee11057fa53e819824fccd7993bbb7464e493)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-22 22:23:06 +00:00
Scott Rifenbark
495fb9287c ref-manual: Fixed redundant link for "build system"
(From yocto-docs rev: 08f9683f53f78cdd13ca760392effb01fc755d57)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-09 14:29:08 +00:00
Scott Rifenbark
f325d43348 ref-manual: Added new terms to Yocto Project Terms section.
Added "BSP", "Reference Kit", and "Build System"

(From yocto-docs rev: f2783d8150ea39e5e116aeebc5305e2c64c3b806)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-09 14:29:07 +00:00
Kristi Rifenbark
a52dc0a11e ref-manual: Added the GCCPIE Variable to Glossary
(From yocto-docs rev: b30f3d3bd6f6d333b00fc9c3797126a898fb0685)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-09 14:29:07 +00:00
Kristi Rifenbark
5d9d10704f ref-manual: Added kernel-devicetree to the Classes section
(From yocto-docs rev: 1ea1f0dc6451030738c506c4d6228b31f67f3f36)

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

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-09 14:29:07 +00:00
Scott Rifenbark
2d363c1955 ref-manual: Updated supported distro list
Removed Fedora 24.

(From yocto-docs rev: 4383c2ac9f1f9ca925518874dc40b8394a2865a4)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-11-12 06:51:20 +00:00
Scott Rifenbark
24503ed3f5 documentation: Set up for "sumo" (YP 2.5) Release.
poky.ent - updated variables
<manual>.xml - updated manual revision tables
mega-manual.sed - replaced "2.4" with "2.5" for links.

(From yocto-docs rev: 15d1f805ad11fba145155dcec17b7ec8a21ad487)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-11-12 06:51:20 +00:00
Kristi Rifenbark
69a6e223f9 ref-manual: 2.4 Migration Revisions
(From yocto-docs rev: 0802de0ca64b7d3581fb2e3ff26d2f72802ade61)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-11-12 06:51:19 +00:00
Kristi Rifenbark
b034103ce6 ref-manual: 2.4 Migration Revisions
(From yocto-docs rev: 1778a743ba3a8b82e96d1e9948e86048d77a8e77)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-11-12 06:51:19 +00:00
Scott Rifenbark
514a808f21 ref-manual: Updates to "Image Generation" section.
Fixed wording on how the OpenEmbedded build system dynamically
generates do_image_* tasks as needed during image generation.

(From yocto-docs rev: 9df98d77a446cd5d27c4e87418117a904b1f4231)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:08 +00:00
Kristi Rifenbark
4cbdb705de ref-manual: First draft of the 2.4 Migration section
(From yocto-docs rev: e0302faa6e7c4ef17c57489e6e6f11b73d8e9b94)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:08 +00:00
Scott Rifenbark
8f03c32040 documentation: Updated title page notes and author group
Made the title page notes consistent across the manual set.

Made the author group information consistent as well.  It is better
that authorship is seen as a third party and not tied to Intel
Corporation.

(From yocto-docs rev: 32cec087e384e1d92e3e84bbae5c6560a0af3136)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:08 +00:00
Scott Rifenbark
3eda52629e ref-manual, mega-manual: Updated Index of Releases figure
(From yocto-docs rev: a7238f165cd6cde6c33d9981577039f8511f5fe3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:08 +00:00
Scott Rifenbark
05967e8e3c ref-manual, mega-manual: Updated example source repo figure
(From yocto-docs rev: 60167c15c08ddaa211c4a1151e6b1a0b00763cc0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:08 +00:00
Scott Rifenbark
e08129f909 ref-manual: Updated "Build Image" section for do_image<type>[depends]
Added information about how the build system dynamically creates
do_image_* tasks (e.g. do_image_ext4[depends]) when creating the
image.  This is functionality that replaced IMAGE_DEPENDS_type.

(From yocto-docs rev: c977df506585aad1ade99c390bacc04b54eb0e48)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:08 +00:00
Scott Rifenbark
708455cdee ref-manual: Updated links to the sdk-manual
The title of the sdk-manual changed.  Many links were updated to
render to the correct book title.

(From yocto-docs rev: 821e29c6c031ae2516fb0e79d0ec3936a5bd624c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:08 +00:00
Scott Rifenbark
3c3dddf3e0 ref-manual: Added links for do_image and do_image_complete tasks
In the "Image Generation" section, I was referencing these tasks
and did not have any cross-link to the actual tasks.  I added them.

(From yocto-docs rev: da480933c59ddc3fe9fe4a881d4d0e21038a999b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:07 +00:00
Scott Rifenbark
149abc5c7f ref-manual: Replaced "vmdk" with "wic.vmdk"
(From yocto-docs rev: c5c77c91269c16dc72cd7b63ce1e7fde1cf1d492)

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

(From yocto-docs rev: 24d0d9509361afe0d61449c7dd056f73318fc01a)

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

(From yocto-docs rev: 5684b6cf373ddc5b18e9e4ae4ae12cede30b8235)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:07 +00:00
Scott Rifenbark
81fbf759a4 ref-manual: Clarified build history as creating a single commit per build.
(From yocto-docs rev: eb5edb5833ece9342cfeb645fbff1154bb2113c7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:07 +00:00
Scott Rifenbark
d076206674 ref-manual: Removed "unsafe-references-in-scripts" test from insane class
This test was removed.

(From yocto-docs rev: 9defac2c0e0d808bc677bd6d115a72e4db6a554c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:07 +00:00
Scott Rifenbark
8020c4e696 ref-manual: Converted external links to internal and fixed dev-manual links
The dev-manual title changed to the Yocto Project Development Tasks
Manual.  Fixed the links for that.  Also took care of some external
links that should have been internal.

(From yocto-docs rev: c1e108e2d13d83bcd6b28c8983336a93642c60a2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:06 +00:00
Scott Rifenbark
6872e89326 ref-manual: Converted external links to internal and fixed dev-manual links
The dev-manual title changed to the Yocto Project Development Tasks
Manual.  Fixed the links to that manual.  Also, fixed external links
that should have been internal to the ref-manual.

(From yocto-docs rev: 76bc9f55e0947689213139927410418a188c893c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:06 +00:00
Scott Rifenbark
2861ddd17c ref-manual: Converted external links to internal and fixed dev-manual links
The dev-manual title changed to the Yocto Project Development Tasks
Manual.  I fixed those links and titles.  Also fixed some external links
that should have been internal.

(From yocto-docs rev: a63abcacb2d21cf3f29eb881ce872b265162d2ad)

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

(From yocto-docs rev: 3ec8452d4f847654096f68c90bf2f7003f5e585c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:06 +00:00
Scott Rifenbark
99739cb83c ref-manual: Converted external links to internal and fixed dev-manual links
The dev-manual title changed to the Yocto Project Development Tasks
Manual.  Fixed links for that.  Also, fixed some external links that
should have been internal to ref-manual.

(From yocto-docs rev: 2369e8d1c1c4f376de0faf6ab02afdea79082d87)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:06 +00:00
Scott Rifenbark
04e72f020c ref-manual: Converted external links to internal and fixed dev-manual links
The title of the dev-manual changed to the Yocto Project Development
Tasks Manual.  I added that to the links.  Also fixed several external
links that really should have been internal.

(From yocto-docs rev: ff2d0010530d6969b2ffd64e6d23c79a18d7f368)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:06 +00:00
Scott Rifenbark
e42ddecaf0 ref-manual: Converted external links to internal and fixed dev-manual links
The dev-manual title changed to the Yocto Project Development Tasks
Manual and I fixed those links.  Converted links that should have
been internal to the ref-manual but were external to the dev-manual.

(From yocto-docs rev: 6de68b04ce1b921466a462dfa3f3485232aaf40d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:06 +00:00
Scott Rifenbark
65e3cb65b2 ref-manual: Converted external link to internal and fixed dev-manual link
The dev-manual title changed to the Yocto Project Development Tasks
Manual.  Updated a link.  Also, fixed a link to a term that should
have been internal to the ref-manual and not external to the dev-manual.

(From yocto-docs rev: 82a44632fd614db1ac00d2e2b4ec85ade77b9aff)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:06 +00:00
Scott Rifenbark
95b24b77b9 ref-manual: Converted external links to internal and fixed dev-manual links
The dev-manual title changed to the Yocto Project Development Tasks
Manual.  Updated the links.  Fixed a few links that should have
been internal.

(From yocto-docs rev: 2125fa0b2a86b8bea0d0e76c4ca349d00bd86e71)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:05 +00:00
Scott Rifenbark
33c74acdee ref-manual: Converted 4 external links to internal links.
(From yocto-docs rev: d1674f4c4d8a8fb90c407bb6779c7572c8210b3c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:05 +00:00
Scott Rifenbark
d9309b2c59 ref-manual: Updated links to dev-manual.
The dev-manual title changed to the Yocto Project Development Tasks
Manual.  Updated all the links.

(From yocto-docs rev: 0ef55f6d379f9c7b37642d51683d807a5eb92253)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:05 +00:00
Scott Rifenbark
6a77a311f0 ref-manual: Converted two external links to internal links.
(From yocto-docs rev: 51c3910d0e120b746066d06e0a0fc1b742cc3c9a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:05 +00:00
Scott Rifenbark
9aa7eace93 ref-manual: Fixed dev-manual links.
The dev-manual title changed to the Yocto Project Development
Tasks Manual.  I updated the links.

(From yocto-docs rev: db42c7f2c1b8fb9037bf32ca957d4bd7444510ea)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:05 +00:00
Scott Rifenbark
207f345d1a ref-manual: Converted two external links to internal links.
(From yocto-docs rev: db050c85848f2e465b694f5caeefde478d984c1e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:05 +00:00
Scott Rifenbark
b8e6656319 ref-manual: Fixed internal links and links to dev-manual
Dev-manual title has changed to the Yocto Project Development Tasks
Manual.  I fixed these links.  Also, had to fix a couple links
that were in an external <ulink> style whereas they should have
been in an internal style (<link>).

(From yocto-docs rev: da5317f802975eaf6b2c5d4026892e5f2051760a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:05 +00:00
Scott Rifenbark
a6db326292 ref-manual: Fixed two internal links.
Links were using the <ulink> style tag when they should have been
using the <link> style.

(From yocto-docs rev: 6c4a39537211ccb322f4ac1c8009ebabcd7b209d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:05 +00:00
Scott Rifenbark
46dd48d731 ref-manual: Fixed local links and links to dev-manual
The dev-manual title has changed to the Yocto Project Development
Tasks Manual.  I fixed links for this.  Also, converted <ulink>
links that were going to internel areas of the ref-manual to
<link> format.

(From yocto-docs rev: bfe4b762ac1c1eb666636a7c2430b3e21787c531)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:05 +00:00
Scott Rifenbark
e41c30aa33 ref-manual: Changed dev-manual title and fixed links
Fixed a couple links that were still going to the dev-manual when
they should have been going to the ref-manual.  Updated the title
to the dev-manual for those links.

(From yocto-docs rev: 0cd84696a569af17a12bb939f203051e78d6fd48)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:05 +00:00
Scott Rifenbark
195d33516a ref-manual: Fixed "Oe-Core" links and links to dev-manual.
The dev-manual name has changed to the "Yocto Project Development
Tasks Manual."  I had to update some references to the manual.

(From yocto-docs rev: 64b5f18b953c89811a08f76a302e29e25ad2fb70)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:05 +00:00
Scott Rifenbark
59e59b37e1 ref-manual: Fixed "Oe-Core" reference links.
(From yocto-docs rev: 1afbf0da0a71d38b48e3db1fa6a5960f5f80018d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:05 +00:00
Scott Rifenbark
cb3b2e1982 ref-manual: Fixed links for "Oe-Core" term.
Added several first occurrences.

(From yocto-docs rev: fa369cfb539c86b59aaf0fff70d9034ea0620cba)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:05 +00:00
Scott Rifenbark
72c820f08b documentation: Updates to cull out buried YP Website references.
With the redoing of the YP website, it was decided that the manuals
could only reference into the top-level and the top-level/documentation
URLs of the website.  I removed all references to areas such as
projects (e.g. Toaster, VM, etc.) and any other URL that was not
the top-level landing page or the documentation page.

(From yocto-docs rev: 2bd838f1a9fb2698bab098b13b76c8852853e0e7)

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

(From yocto-docs rev: 0e4f245f2b872810e2e164a227900ca6aa313ab8)

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

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

(From yocto-docs rev: b4d5b7077a978e4966d1273a374741075a1b0c7d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
Scott Rifenbark
6077ebbe80 ref-manual, dev-manual: Moved plug-in section for wic to ref-manual
Fixed links affected by the move.

(From yocto-docs rev: 250d312274788b0eebf3ae9143f2f89eafd4ab90)

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

(From yocto-docs rev: 8b2a3eafa10b1f6fdf034e6e13d0277c9a556170)

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

(From yocto-docs rev: d0c54caf2a2a6ccb9a6fb38b77c9827b66b9ff10)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:51 +01:00
Scott Rifenbark
3823b6edd3 ref-manual: Fixed typo
(From yocto-docs rev: eb16cc85e9a14e82d5416f6a4a3ebc9eff7c3057)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:51 +01:00
Scott Rifenbark
b8d329644f ref-manual: Fixed redundancy in MACHINE list for runqemu command
In the "runqemu Command-Line Options" section there is a bulleted
list showing options you can provide.  The "MACHINE" option lists
valid values and listed "qemux86" twice in the list.  I removed
one of them.

(From yocto-docs rev: 7831b60391544e9fca94b1fe299ec4cb57992222)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:51 +01:00
Scott Rifenbark
59ddd7c386 ref-manual: Added Debian GNU/Linux 9 (Stretch) to supported distros.
(From yocto-docs rev: f759827b163a844b4f9eb31b2a4ecea56d2aa004)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:51 +01:00
Scott Rifenbark
e99b83f4b0 Documenation: Updated "Usually October" to "October 2017" string
The string in the manual revision table needed updated across the
set except for the kernel-dev manual.

(From yocto-docs rev: e087a707e02ff913baba2ac8bc6594206f53f70c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:34 +01:00
Scott Rifenbark
50c8c730ad ref-manual: Updated Metadata term in Terms section
Provided a description for metadata in the context of the kernel
that ties it to the yocto-kernel-cache Git repository rather
than the old meta-* directories that were in the actual
kernel trees.

(From yocto-docs rev: 7105459bf687cad7d973d8bdffbc51c9ffcd9721)

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

(From yocto-docs rev: 98c40729b2b22a2ac8444d899848c05880cb920b)

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

(From yocto-docs rev: 5041a2a26d703a885437abcedb24c7600d5365cd)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:33 +01:00
Scott Rifenbark
fae276ea09 kernel-dev: Eliminated "Generating Configuration Files" section.
This section was largely redundant now.  The small things that did
add value I placed in other areas of the chapter 2.  One was a new
section on expanding variables using bitbake -e.  Another was a bit
about the defconfig file.  And a small procedure on how to create
config fragments using the "diffconfig" command was retained.

Links from the dev-manual and the ref-manual were adjusted as well.

(From yocto-docs rev: 7059d3eac1fec20089cabf197503f1bec747686d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:33 +01:00
Kristi Rifenbark
ab9f5a5300 ref-manual: Updated Added a New Recipe to Workspace Layer section
Fixes [YOCTO #11392]

Updated the section to document how to specify a branch,
tag, or revision when using devtool add with a remote
URL.

(From yocto-docs rev: 903b4a4e72908572a5f8b8c822869bbd0fe76ec9)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:32 +01:00
Kristi Rifenbark
3cc1668534 ref-manual: Updated devtool --help output
Fixes [YOCTO #11392]

(From yocto-docs rev: 30eb6ef13b85f7f5e1784dbdd6a54b1367be212d)

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

(From yocto-docs rev: 789a11aee778f6082134102659b317bc6c155b4c)

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

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

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-26 11:18:59 +01:00
Scott Rifenbark
de671802c8 dev-manual: Compatibility program and moving kernel configuration
Should have been two commits but I forgot to do them separately.

1. I updated the YP Compatible Program section.

2. I moved the "Configuring the Kernel" section from the dev-manual
   to the kernel-dev manual.

(From yocto-docs rev: cdb5bbc917db55a2ca987ce9b9ed371f9fca6524)

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

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

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

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

(From yocto-docs rev: 274b05108d1bc53df20c11ab2efa15363bce23da)

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

(From yocto-docs rev: 6d51dfb9de53db1222f68a6f0325eaad1a12cd6b)

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

(From yocto-docs rev: d87726cf4962ca093c63d23d9e04f41d448c9594)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-13 18:00:18 +01:00
Kristi Rifenbark
734de503fa ref-manual: Added new section on virtual providers
Fixes [YOCTO #11762]

(From yocto-docs rev: 2633bae48fa08cd3a889d3f205abcc9833b1be2f)

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

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

(From yocto-docs rev: eb602d0a5fca67228607710d5d33873f1b0529f1)

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

(From yocto-docs rev: 362998c71b44ddf89d32ed5c45e4251e932a9217)

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

(From yocto-docs rev: 9ab6e6aed685c9419cb7df3df3ab029033d9ba0e)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:49 +01:00
Scott Rifenbark
95d5e56c29 ref-manual: Fixed broken link.
(From yocto-docs rev: 79d1615389f51a0856ea4130684a618abb1c6a93)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:49 +01:00
Scott Rifenbark
68179b1edc ref-manual: Removed duplicate section id.
(From yocto-docs rev: b5ef950136b2d2bb00fdd86f971f77cb744a8c82)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:49 +01:00
Kristi Rifenbark
7aabb9c41f ref-manual: Added a cross-reference link to "tmp/sysroots-components"
(From yocto-docs rev: 29458d81901336ae7c904a23e02786e024f20963)

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

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:48 +01:00
Kristi Rifenbark
49bc3e3d3e ref-manual: Added tmp/sysroots-components task
(From yocto-docs rev: ae635dfc2f53e026b597c1d2ca93ecaa9416417c)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:48 +01:00
Kristi Rifenbark
a447c9d13f ref-manual: Corrected spelling errors
Updated two instances of "sysroot-components" to
"sysroots-components".

(From yocto-docs rev: 035be964e6f345c058c1dacbb58b09745e8f827d)

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

(From yocto-docs rev: 37388eccf162811ba7b9fd3ee3c110a8fa0f2556)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:47 +01:00
Kristi Rifenbark
fe72ceaa4e ref-manual: Fixed links in do_prepare_recipe_sysroot task
(From yocto-docs rev: 80c60be5f560d20ee60270df0de2c86b23e004df)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:47 +01:00
Kristi Rifenbark
b46f3e8e16 ref-manual: Edited Migration section
Edited OpenEmbedded reference in "Recipe-specific
Sysroots" secion. Edited bullet title in
"Recipe-specific Sysroots" section.

(From yocto-docs rev: b2ee4bb8b31d5c7df22287ae390e68c845ec0732)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:47 +01:00
Kristi Rifenbark
552c252959 ref-manual: Edits to staging.bbclass
Added a missing closing parenthesis. Edited Note for
for file clarification.

(From yocto-docs rev: fd7bb7aa57cfcf8b77f82edea65773e50e751902)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:47 +01:00
Kristi Rifenbark
94a80c4d36 ref-manual: Updated build/tmp/work/tunearch/recipename/version
Replaced "recipe_work_directory" with "${WORKDIR}"
throughout the section.

(From yocto-docs rev: a961cf07cd18d06e0c6399a10dc40c0d4143c23f)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:47 +01:00
Kristi Rifenbark
6716106c6f ref-manual: Updated Documentation required packages
Removed xsltproc package in Fedora, CentOS, and
openSUSE Documentation required packages. Removed fop package in
openSUSE Documentation required packages.

(From yocto-docs rev: 58c4384974ac29f6f591a51d66a5041a29695e76)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:47 +01:00
Scott Rifenbark
d369f33383 dev-manual, ref-manual: Moved recipe syntax section to ref-manual
The section on recipe syntax that was buried in the creating a
new recipe section was really a reference on syntax.  I have moved
it to the ref-manual.

(From yocto-docs rev: cb55d1b5832cca6faa6e2a5b26f3add3032cade2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:47 +01:00
Scott Rifenbark
7d7eb04b9c dev-manual: Updates to "Using .bbappend Files in Your Layer"
I did some rewriting for clarity in the "Using .bbappend Files
in Your Layer" section.  The section needed to be retitled so
focus on the layer aspect of .bbappend files.  Also, while I
was in there, I did more work on the prose in general.

Also had to fix some links in the bsp, kernel, and ref manuals
that linked into the section whose name I changes.

(From yocto-docs rev: a82bcc9fe0f909135434ee1bd36b4414f6c046c9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-08-09 09:25:24 +01:00
Scott Rifenbark
f4aa9783bd yocto-project-qs, ref-manual: Moved YP intro from QS to ref-manual
Fixes [YOCTO #11630]

The introductory stuff in the QS is really conceptual information and
needs to be in the ref-manual where YP is introduced.  Regarding the
QS, all we really need to do is point to places where the reader can
go to find that stuff out.

Part of this move involved getting the diagram of the YP flow for
the environment from the QS to the ref-manual.  That figure was
named "YP-flow-diagram.png".  It was named "yocto-environment.png"
in the QS but I renamed it when moving it to the ref-manual.  This
caused some edits to the "Makefile" to clean up the figure lists
for tarballs.

(From yocto-docs rev: ab108c0959e3a9f36d25080245482f8a790c8c87)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-30 16:23:51 +01:00
Scott Rifenbark
3c1c4ceaa4 yocto-project-qs, ref-manual: Upgraded tar to 1.27 from 1.24
The minimum version of tar is now 1.27. This was changed in both
the yocto-project-qs and ref-manual.

(From yocto-docs rev: b0fe513e08de860e94a3617fd62382430e321c77)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-27 23:00:23 +01:00
Scott Rifenbark
15901164ee dev-manual, ref-manual: Eliminated pre-built section
Fixes [YOCTO #11630]

I took the section that described how to use a pre-built kernel
and run it through QEMU out.  This is basically a QEMU usage
section and is not in that area.  There were some QEMU speed
up items suitable for the QEMU concepts section in the ref-manual.
I put those in that area.

(From yocto-docs rev: b081013aa10b42e4eb88ed54940112c5ae106911)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-22 09:19:25 +01:00
Scott Rifenbark
2217d97ba9 dev-manual, ref-manual: Re-wrote QEMU section.
Fixes [YOCTO #11630]

I converted the QEMU section to a procedure.  Also took the
tips section and created individual sections from that.

Cleaned up some areas in the QEMU conceptual section in the
ref-manual

(From yocto-docs rev: dfd3466be605fdd7438653bf54fd0df3594a5c50)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-22 09:19:25 +01:00
Scott Rifenbark
88c188f990 ref-manual: Added QEMU reference section
Fixes [YOCTO #11630]

The dev-manual had a section on QEMU that combined a lot of
reference information and usage information.  I took the reference
information out and moved it to the ref-manual into a new section
in the second chapter, "Using YP".

(From yocto-docs rev: 188596c576e357925383d0cc3bd2b0cdf41926ec)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-22 09:19:25 +01:00
Scott Rifenbark
aa1162685f ref-manual: Cleaned up the description of INITRAMFS_IMAGE variable.
(From yocto-docs rev: a85647193c202fcd36c70122240b54aa5672c895)

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

(From yocto-docs rev: 80b474d3417e88a47d1317b2af6552698e907b80)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:15 +01:00
Scott Rifenbark
3f65f662ba ref-manual: Added "Toaster" to the list of terms.
(From yocto-docs rev: d6325a02c252c241e544f55f1d436dcf784de4db)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:15 +01:00
Scott Rifenbark
ba6887404a documentation: Re-write of dev-manual setup chapter
Fixes [YOCTO #11630]

The chapter on setting up YP has been completely re-written to
move towards a "how-to" manual.  This involved touching every
aspect of the chapter.  All subsections now have procedures
surrounding set up stuff.  There are some development sections that
still need fleshed out.

Many, many links and references in other chapters were affected.
These have been fixed.

A couple style-sheet (*.css) files were also updated to support the
"writernotes" style, which renders paragraph text in red.

(From yocto-docs rev: c4c2a6cf575ce5c783b1cc84d9f7e961aebef49c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:13 +01:00
Scott Rifenbark
ed25d7df9c dev-manual, ref-manual: Added procedure for Downloads page
Fixes [YOCTO #11630]

Added a new procedure section for using the Downloads page from
the YP website.

(From yocto-docs rev: 7efb29dfa7a0960710ca7cf3983048f166c6a13f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:13 +01:00
Scott Rifenbark
534a614312 ref-manual: Added style "writernotes" to *.css stylesheet.
This addition allows an author to use the following form to
highlight a paragraph in red.

   <para role="writernotes">
   Blah Blah Blah
   </para>

(From yocto-docs rev: 40d646229e5ec9fa905a372be795120449f9f9dd)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:13 +01:00
Scott Rifenbark
576af718e6 dev-manual, ref-manual: Added section on index of releases procedure
Fixes [YOCTO #11630]

I have added a new procedure on using the Index of Releases area
to get snapshots of various tarballs.  I recommend that is not
the way you usually want to get files as using Git is recommended.
The section exists for completeness.

In the ref-manual, I cross-reference the procedures from the
associated conceptual areas.

(From yocto-docs rev: 812f344966966591d883fbebb4ae1f72c11dd483)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:13 +01:00
Scott Rifenbark
5cbd459c64 ref-manual: Fixed spelling error.
(From yocto-docs rev: 8dc9623efec7624b137055d21762aeb0c1b36562)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:13 +01:00
Scott Rifenbark
8ee16983cb dev-manual, ref-manual: New section on viewing GUI YP repositories
Fixes [YOCTO #11630]

I created a new procedure for locating and viewing YP source
repositories using the GUI-based method.  Created an anchor in the
ref-manual so I could reference the 'git clone' command.

(From yocto-docs rev: 2ae28682407039420f4fcca71a298e1dd34c81f0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:13 +01:00
Scott Rifenbark
d3a0e0abc1 dev-manual, ref-manual: Established section on YP source files
Fixes [YOCTO #11630]

To move toward a "how-to" dev-manual, I am consolidating procedures
for locating and establishing local copies of YP source files into
a single heading.  I set up a "Working With Yocto Project Source
Files" section.  This will contain sub-sections to find the various
areas of YP files and how to clone and check out stuff.

(From yocto-docs rev: 87ff4ee41a50e8aed6b9c5402c51bb47f5a252a3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:13 +01:00
Scott Rifenbark
0f00914578 documentation: Reorganized YP introduction material.
This material was being replicated across the Quick Start,
dev-manual, and ref-manual.  I have created a single point in the
ref-manual that collects the disparate information that existed.

I deleted the entire section in the dev-manual since that book
is converting to a procedure manual and the very front of the manual
adequately mentions YP and provides pointers to where the user can
get more information.

The QS provides a more complete introduction of YP since it is a
QS.

(From yocto-docs rev: bd8093417af2d93556410d5482dad32c11a0a964)

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

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:45 +01:00
Kristi Rifenbark
477ee32dbe ref-manual: Fixed spelling error "containe"
(From yocto-docs rev: cf8032bf7c3bc484b63ee46c195ee1537b1f817f)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:45 +01:00
Scott Rifenbark
cf2169b351 dev-manual, ref-manual: Re-wrote the intros
Fixes [YOCTO #11630]

I updated both the introductory sections of the ref-manual and the
dev-manual.  These need to work more tightly with the projected
YP documentation set.

(From yocto-docs rev: 6a28537d03fad8a53198edc7f9a6229f4e58e551)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:45 +01:00
Scott Rifenbark
eed50a14fe documentation: Changes section head for sumbitting change to YP
Fixes [YOCTO #11630]

I changed the section heading for the section that describes how
to make a change to the YP.  It was passive.  I need it to be
active and in line with the "how-to" dev-manual.

(From yocto-docs rev: 340e1b6ab9806ec11ec894d4472bc2c937c2b058)

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
Kristi Rifenbark
a331904ab2 dev-manual: Fixed two grammar errors
(From yocto-docs rev: 4e68646edf078c23e414a300b37cb30774b28be7)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:44 +01:00
Scott Rifenbark
b5ffe8974b ref-manual: Added "see also" informational note at beginning.
(From yocto-docs rev: 3af3d821b6e26fd352223f3f4196e0e200614203)

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
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