The wording to two links (one a variable and one a section in a
different manual) was ambiguous. I added phrasing to remove that
issue.
(From yocto-docs rev: 3b70b4287ca8b2583e0ef559125f1531a2bb6a67)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed the link to WORKDIR to begin with. Also, removed the
<filename> formatting that was within the example, which is buried
in a <literallayout> tag set. Doing that screws up the formatting.
(From yocto-docs rev: 0d13dabaa13e5426da35b5d8147f51efa349b5bb)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added "class" as a modifier after refering to the "populate_sdk_base"
class.
Removed link to the TMPDIR variable in an in-line example.
(From yocto-docs rev: 7733a4464ba2893a2363f47996f48587a86eaa82)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Several redundant links and wordings in this description.
(From yocto-docs rev: bb9dd8ab6ef9cad387cdddada4f2be093551e38a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A migration item had taken the original section for the target of
the link out. I had not changed it.
(From yocto-docs rev: 10cfaee50455bf10450540f1b381d33f9babf985)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Two instances where links were going into the kernel-dev manual
but the manual title was not being used in the text. Added it.
(From yocto-docs rev: 1922f8c79d1667db1fc9b5fe57030302469ca09c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The link was to a chapter in the existing manual. I do not
include the manual title when that is the case.
(From yocto-docs rev: 1b7c65b4a2dde3f5d069cb5edc75728492639870)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Link was going to TARGET_PREFIX.
(From yocto-docs rev: 424e8ea3168ab2e910919e6f70fc0b16332ca4f7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I replaced the "<" and ">" constructs with the tags
<replaceable> and </replaceable>. This is the preferred formatting
for user-supplied values.
(From yocto-docs rev: 1fc32486483c545671ffb2142b553da75dbe54fe)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the BBMASK variable, a link to Python documentation was
going to a specific 2.6 release. That release was probably the
most recent when the BBMASK variable was initially documented.
Python has many releases now (e.g. 3.6.5). I re-worded the
description to be more generic and sent the user to the general
Python release area. They can pick a release from that URL.
(From yocto-docs rev: 154aedf79625f37997bec18dba933c514072708e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed the first link to the BB_DISKMON_WARNINTERVAL variable.
The variable was linked later in the text. No need to link
the output version of the variable... clunky looking.
(From yocto-docs rev: ec6cfc85ba2f1e2fc763b6b7c918a21cec00e203)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed wording so I could reference the proper name of the
LABELS variable.
(From yocto-docs rev: 05e5f287bde8219d1f8125d71fd48a36a422009a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This involved changing the root manual folder from
"getting-started" to "overview-manual".
Also, every link using the ENTITY "YOCTO_DOCS_GS_URL" was
changed to "YOCTO_DOCS_OM_URL". Most manuals had several
occurrences of these links.
The makefile needed updating to process the new manual
and not process the old "getting-started" manual.
(From yocto-docs rev: 1abf64e56e9096258038ae37b787a81bf786bb3b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The concepts-manual is going away for 2.5. I have fixed all the
links across the YP documentation set that were cross-referencing
into the concepts-manual so they now cross-reference into the
getting-started manual, where that concepts chapter will live
post 2.4x.
(From yocto-docs rev: e9145e9e7fef882a13c982d34514a94f864b3c12)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Throughout the manual set, I made sure that "OpenEmbedded-Core"
and "OE-Core" appear with the hyphens.
(From yocto-docs rev: 1f570df3eccb74b9e2e60af94c0e0dd48e1489e9)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Using "OpenEmbedded-Core" rather than "OpenEmbedded Core" in the
text. The term as also fixed to reflect this change. Also,
use of the phrase "OpenEmbedded-Core project" or "OE-Core project"
is not desirable. Changing project to version.
(From yocto-docs rev: ec226fcd92847c96ea2e11d34513b597a35c9825)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a final paragraph that provides some cross-referencing to
the sections that describe how to use Wic and to the Wic
reference chapter.
Also, shortened the DOC info line.
(From yocto-docs rev: 4ba5d0119caa3696187537f5b4cc9c64ca00e205)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a link to the "getty" term.
(From yocto-docs rev: d21fe1ea33353e15c135af7fc302ffe636310541)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added minor edits to clarify that we are talking about an
image type.
(From yocto-docs rev: 14c906aa539d127c88d71d7fb3e628fc225cbd52)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Created a new variable description in the glossary. This
variable is used in the layer.conf file and needed to be
documented.
(From yocto-docs rev: 5c514c0e90ca920bdf183b1f9449a06b906235ca)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added the fact that this variable is really optional. If you
don't use it then you are setting up a package feed URI that
will include all supported arcchitectures for the package.
Using it means you are setting up specific URIs for specific
architectures.
Added a "Tip" note box to show how you can use the variable
to whitelist architectures.
(From yocto-docs rev: 009f3551aa61aaf6459fd24105a2e06511b59da3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I created a two-bullet "Caution" note to highlight the stuff a
user needs to be aware of that can cause problems.
(From yocto-docs rev: 553bc13e5fd350adb15400afe170e587965929db)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Provided more details in the explanation and fixed a link to the
section on using virtual providers.
(From yocto-docs rev: ace74e24f001b83c9177266b0a6f15ce96dd04b0)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section that provides a closer look into the build system has
moved from the getting-started manaul to the concepts-manual.
I fixed all the links, provided some coded formatting of the
entire section, and made general updates.
The other manuals had links that needed fixed due to the move.
(From yocto-docs rev: b83a5619f56ebd9879fdcadcf474859e68b26d58)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
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>
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>
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>
