Commit Graph

2024 Commits

Author SHA1 Message Date
Scott Rifenbark
9fb35c02b6 ref-manual: Enhanced link to the host-user-contaminated test.
The link was just going to the top of the section.  I added an ID tag
to the actual host-user-contaminated test within that insane.bbclass
description.  Now, the user is linked right to that test.

(From yocto-docs rev: b1e5b5a1876e211a8c57bfa727fa9031cfe5e0ac)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:18 +01:00
Scott Rifenbark
ac798d5543 ref-manual: Fixed broken link to do_image task.
Had the wrong ID in there.

(From yocto-docs rev: 6d52354b42709867ef61543de6d3b630fd780bab)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:18 +01:00
Scott Rifenbark
9e6c097f74 ref-manual: Removed link to DEPLOY_DIR variable.
The focus of the discussion here is on the DEPLOYDIR variable.
Having the link to the variable DEPLOY_DIR adds clutter to it all.
Removed that link.

(From yocto-docs rev: 8561c70fcff88adc82c7c5998d2539d40b314888)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:18 +01:00
Scott Rifenbark
efdb62b770 ref-manual: Removed redundant link to IMAGE_FSTYPES variable.
(From yocto-docs rev: 8b6dbb3259b4875e7443a5ceb55f5d593b2409a2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:18 +01:00
Scott Rifenbark
74e620e060 ref-manual: Removed redundant link to the C/C++ Compiler Cache.
(From yocto-docs rev: 1e7898f584e0ca4f5dcfaef447b70aec36867051)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:18 +01:00
Scott Rifenbark
e387870ac8 ref-manual: Fixed wording on how autotools classes build by default
Took out stange parenthetical construct and the links to the B and
S variables.  Links were redundant.  The construct was weird.

(From yocto-docs rev: 9cd2bf116bd89288a93944359a4809e68fa61f7b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:18 +01:00
Scott Rifenbark
36706a55ee ref-manual: Removed redundant link for "Source Direcotory" term.
(From yocto-docs rev: 82ebe64671cf298a8e9c53b2975540542f10b28f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:18 +01:00
Scott Rifenbark
6f9df237c2 ref-manual: Removed redundant link to WORKDIR variable.
(From yocto-docs rev: 66ab70483fe1ab963b6e5e822797b144f787a139)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:18 +01:00
Scott Rifenbark
4108f153fe ref-manual: Removed redundant link to "Build Directory" term
(From yocto-docs rev: 37ddada28753fe89cd56b44b4f1e5896cf71cc23)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:17 +01:00
Scott Rifenbark
3b50981d05 ref-manual: Fixed link to "naked" bsp-guide reference
A "naked" reference to the bsp-guide was split across two lines
in the *.xml file.  This splitting causes the link to not be
processed correctly by the mega-manual.sed script.  I joined the
two lines to fix the link.

(From yocto-docs rev: e31b4d2210b5c246f3e822fbe8950a625e08ca98)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:17 +01:00
Scott Rifenbark
5776e0bcd1 ref-manual: Added "section" as part of a reference to the bitbake-user-manual.
Missing this conventional part of the reference contextual diatribe.

(From yocto-docs rev: 5468ebf21bc9166de35e9b7016eef06ed586e5c3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:17 +01:00
Scott Rifenbark
1b2b0a267d ref-manual: Removed several redundant links to variables.
Trying to get back to a standard of using an actual link for only
the first occurrence of a variable in any given section.

(From yocto-docs rev: 68d80a5dd8481f938892473c4671a9c436e80c8f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:17 +01:00
Scott Rifenbark
11c4aa61c1 ref-manual: Removed redundant links to the DISTRO_FEATURES variable.
(From yocto-docs rev: d834e5f5cef520b80e5049b28945cfa1ead3b092)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:17 +01:00
Scott Rifenbark
ade3eec9f4 ref-manual: Fixed bad title for the bitbake-user-manual
In the migration section, an older name for the bitbake-user-manual
was being used in the text for a cross-reference.  I replaced it
with the current and correct name.

(From yocto-docs rev: 3f466b59a3138984cceae12ac58c84ec3cda4432)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:17 +01:00
Scott Rifenbark
e467a8ceca ref-manual: Fixed bad link to naked sdk-manual
In the migration section, an older flavor of the title to the
sdk-manual was being used.  This of course was not processed
correctly by the mega-manual.sed script.  I fixed the title so
it is now processed correctly.

(From yocto-docs rev: 1f9fa699bb14f96a7c9ccab314a7d72e6a93dda6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:17 +01:00
Scott Rifenbark
f5590e221a ref-manual: Fixed bad title string for "Toaster User Manual"
(From yocto-docs rev: 14efbdbbcffea3a301dd220b3336fd11e1878ff8)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:17 +01:00
Scott Rifenbark
a6298bf144 ref-manual: Removed redundant paragraph for links to variables.
(From yocto-docs rev: 32228c3e138d6bd0076b164980e90fdc25c62768)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:17 +01:00
Scott Rifenbark
cf4fd9a7b5 ref-manual: Fixed mis-matched title in link to ptest.
(From yocto-docs rev: d203312ede89d5c7467f8ac8117522c4fc1fd7b5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:17 +01:00
Scott Rifenbark
4ea244eac3 ref-manual: Removed redundant link to the BAD_RECOMMENDATIONS variable.
(From yocto-docs rev: 27ce95176fcceb95065eee19fecc2a71d88a0984)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:17 +01:00
Scott Rifenbark
869796c0eb ref-manual: Removed redundant link to IMAGE_FEATURES variable.
(From yocto-docs rev: 0ca8dc6aa8e06405e9483398788f4e221408fed7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:17 +01:00
Scott Rifenbark
2f8bf57204 ref-manual: Fixed a link to a naked manual reference
The terms.xml chapter had a link to the toaster-manual where the
string to the manual was not matching the string used in the
mega-manual.sed file.  Consequently, the link was not being processed
correctly.  This type of link should not be a link in the mega-manual
because the target is to the manual in general.  Fixed the string
of the toaster-manual to match what is being used in the mega-manual.

(From yocto-docs rev: 44042847db10b15f8694199162ad96dea44d21bc)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:17 +01:00
Scott Rifenbark
63e57d9cb5 ref-manual: Updated buildtools example script
(From yocto-docs rev: f9d46c43a2f5961fb9bda6758f8c2cdeef100281)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:17 +01:00
Scott Rifenbark
78063fa86a ref-manual: Updated example buildtools .sh file.
(From yocto-docs rev: 36fecfc69f60c99a58c86fc3f1890382fb013887)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:16 +01:00
Scott Rifenbark
a3db0190df ref-manual, poky.ent: Removed old ENTITY to kernel-manual
Found a link to the old kernel-manual in the reference manual.
This manual is not used.  I changed the link to use the proper
ENTITY value and also removed the old one from poky.ent.

(From yocto-docs rev: f1377989ab4a85827f5aaab9b19c4fb3c10567ca)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:16 +01:00
Scott Rifenbark
14ea87e2ee ref-manual: Fixed a link.
(From yocto-docs rev: 79e8ae28a3da4c135227ba44e707a1adde61a24f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:13 +01:00
Scott Rifenbark
1b877bc9dd documentation: Updated everything for new overview-manual
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>
2018-05-24 17:16:13 +01:00
Scott Rifenbark
4fd8b39b24 dev-manual, ref-manual: Fixed two broken links.
(From yocto-docs rev: 1ce02bf1c81629d9e008c05b48c4cddad264bafc)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:12 +01:00
Scott Rifenbark
2b9e973910 documentation: Changed getting-started manual titles
Throughout the documentation, the manual "Getting Started With
Yocto Project" was used.  The manual now is called "Yocto Project
Overview and Concepts Manual".

(From yocto-docs rev: f47d10029487420cbeb292f680084b63be0ec7e9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:12 +01:00
Scott Rifenbark
982cce2d2c documentation: Fixed links to old concepts-manual
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>
2018-05-24 17:16:12 +01:00
Scott Rifenbark
974c87594b documentation: Removed references to the concepts-manual
Removed all the references to the top-level of the old
concepts-manual.  These references are references that do not
have a "#" target.  They just reference the manual in general.

(From yocto-docs rev: 5b33f3c119807532aa6feb2d010c9c9f780a26d8)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:11 +01:00
Scott Rifenbark
3f047c748b documentation: Fixed links to concepts-manual.
Some inconsistencies in the links to the concepts-manual existed.
I fixed these throughout the YP manual set.

(From yocto-docs rev: ad7f840bb6f4a5248ef455b98ce9b35197e07e1a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:09 +01:00
Scott Rifenbark
aa3275e953 documentation: Fixed "Getting Started" manual links
There was inconsistent use when referencing the getting-started
manual.  The manual's name does not include the word
"Manual".  So, I cleaned this up across the manual set and
also in the mega-manual.sed file, which was incorrectly
processing the links to that manual that do not target a
specific section.

(From yocto-docs rev: 0f5321416f7ec50cb6c96cccb7c87ef191a25367)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:09 +01:00
Scott Rifenbark
ef25f6b950 mega-manual: Fixed various links to the dev-manual
Found a few links that were not using the correct wording when
referencing a section to the dev-manual.  Also, fixed one link
that was assuming a section outside the dev-manual when the
link was to a section inside the dev-manual.

(From yocto-docs rev: 7a577b135e1a01d6a9924ba89733e46d029c6cca)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:08 +01:00
Scott Rifenbark
f91f4b9b36 documentation: Updated "OpenEmbedded-Core" terms.
Throughout the manual set, I made sure that "OpenEmbedded-Core"
and "OE-Core" appear with the hyphens.

(From yocto-docs rev: 1f570df3eccb74b9e2e60af94c0e0dd48e1489e9)

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

(From yocto-docs rev: ec226fcd92847c96ea2e11d34513b597a35c9825)

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

(From yocto-docs rev: d4598e7e43a8bafa4ff6ddeec50febcedc41b411)

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

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:08 +01:00
Kristi Rifenbark
63168f74d3 sdk-manual: Cleaned up section IDs between Neon and Oxygen
Updated section IDs for the new Using Eclipse Neon
Appendix and Chapter 5 Working Within Eclipse (Oxygen).
Changed one link found in reference manual.

(From yocto-docs rev: d767007cf4151127063d1992a4e11e90437ae2da)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:07 +01:00
Scott Rifenbark
f2242e613c documentation: Purged the YP Quick Start references from YP set
The original Yocto Project Quick Start is being retired for the
YP 2.5 release (sumo).  I have purged all the various references
from the YP manual set and replaced them with references to the
appropriate doc.  The references were mainly into the YP
dev-manual for setting up the host or for building an image.
There were a few references into the new "Yocto Project Quick
Build" document for overviewing manual-type references.

(From yocto-docs rev: 11c0ab693962f16f87f1e21f33dd5c6ca6a6f895)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:07 +01:00
Scott Rifenbark
35734315dd ref-manual: Deleted the "ref-bitbake.xml" chapter
This information was merged into the BitBake User Manual.

(From yocto-docs rev: eb68d4429aed652e4ca10c1ab55d3a815d453d6f)

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

(From yocto-docs rev: e91db865686e7b1b9b21cb9aea892b0ed8884438)

Signed-off-by: Joshua Watt <jpewhacker@gmail.com>
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:05 +01:00
Scott Rifenbark
7907cb7b6c Documentation: Updated Manual Notes
I did some re-wording to account for when the user does a web
search for a manual and the search returns an ancient version
of the manual.  Many times the user is oblivious of this fact
and is trying to use a version of the docs that don't come close
to matching the version of the YP.

(From yocto-docs rev: 1cbe06cefda2b35584a8365564e01888d229d0b3)

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

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

Also, shortened the DOC info line.

(From yocto-docs rev: 4ba5d0119caa3696187537f5b4cc9c64ca00e205)

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

(From yocto-docs rev: d21fe1ea33353e15c135af7fc302ffe636310541)

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

(From yocto-docs rev: fdef057927b7b0dba64b9b7f952108fdb9c97f34)

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

(From yocto-docs rev: 14c906aa539d127c88d71d7fb3e628fc225cbd52)

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

(From yocto-docs rev: 5c514c0e90ca920bdf183b1f9449a06b906235ca)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:03 +01:00
Kristi Rifenbark
6ee6a14491 sdk-manual: Added new appendix for Neon
Fixed [YOCTO #12417]

(From yocto-docs rev: 9f6b874740b98c5b3eed1c06dcf5fbe687279ca8)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:02 +01:00
Scott Rifenbark
dcde1a9e33 ref-manual: Added term "container layer"
This is a layer that contains other layers

(From yocto-docs rev: 0cd1881c18e8a63d5f2f078b03fe4e89fd9c75b5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-25 09:41:13 +01:00