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>
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>
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>
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>
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>
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>
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>
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>
For conserving disk space during builds, I added a new section
that tells how to add "rm_work" to your local.conf file.
This information was part of the original YP Quick Start
and was not carried forward into the new brief build
document.
(From yocto-docs rev: 719d70587d908390a134559472d57ce7fced6aae)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
Updated the explanation of the layer.conf file. I am going
to use this section as the definitive section that explains
the layer.conf file.
(From yocto-docs rev: 4c70c7467f0ca5cf2346ef8d10bde437b971d2d2)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added information to the list of variables used in the
layer.conf file to specify LAYERSERIES_COMPAT.
(From yocto-docs rev: c41ff41e75b654d5d7df8c2a1e83ba5525490285)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
For step 3 on creating the layer, I put in wording to make sure
the user does not create a layer in the cloned poky directory.
(From yocto-docs rev: 1a0d1d0c0cdfa77c6df005d0294d11a02ca3770c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Best practices dictate that the use not create a layer in the
poky repo. So, I updated the example to move the user to a
top-level directory first and then create the layer.
(From yocto-docs rev: 81ab8b0f393f90785880aec7685c4c431cb7ad87)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reality dictates that the YP does not treat layer naming consistently.
Layers are talked about as the "meta-whatever" layer and never the
"whatever" layer. However, the tooling sometimes appends or uses
just the "whatever" part of the layer name. A good example is the
meta-yocto-bsp configuration file. All the variables in there use
just the root name of a layer's name. In the manuals, I had been
distinguishing the layer name as just the "whatever" part sans
"meta-". I talked about the convention of using "meta-" in front
of layer names, etc. Well, this is confusing in light of how everyone
says a layer's name is "meta-whatever". So, I fixed all this up.
(From yocto-docs rev: 79e52f6ccf4246fc69a460ce9d3a4a18720a9442)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Split this section into two sections: one for creating the layer
using bitbake-layers create-layer and one for adding the layer
to bblayers.conf using bitbake-layers add-layer.
Needed to update some references in the yocto-project-qs and
kernel-dev manuals.
(From yocto-docs rev: 741a29b0cbeaaeaa0ac9155036ace2623938aee3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12419]
In the section on runtime package management, I created a "Tip"
box to tell the user about using a location for the package
index information outside of the "deploy" area of the hosts
build directory.
(From yocto-docs rev: 2aee814d3d3ed4052fca332693d5416907ae640e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Provided some key links to help clarify content.
(From yocto-docs rev: 8d27b9946dad89729d30497bcc4de26b9a5c87d9)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12419]
This section was unclear and needed some work. I added text to
help clear things up.
(From yocto-docs rev: 54358a39a5710dbd0cbcfe8dafd2f641ec3863ef)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The example that creates a layer using bitbake-layers had old
output. Updated it.
(From yocto-docs rev: c58d738a59f113f8fffe0fc40b22e06b9d96cb6f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Section covers AUH, devtool and manual. Still need to add
manual.
(From yocto-docs rev: 56f04b1fcc8673e20df6d8f5c65120b03cad31e7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The old heading was dangerously close to a heading in the
previous chapter. I altered this heading to target more
specifically the content.
(From yocto-docs rev: 797bef2256308531f02e35dc0ef8b1d9cbaff935)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Needed to call out that using the include file is actually
using a MACHINE configuration file in this case.
(From yocto-docs rev: b33838d4711e0c55c6cf78e7491ce97bc9fd519f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This topic was deemed unfit for concepts so I moved it to the
dev-manual and rewrote it to be "Using Virtual Providers".
(From yocto-docs rev: df7d48ac4fcf7ece75681ccf0bbb5699f7ff5ea6)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I had split up the section on x32 into a concept piece and a "how-to"
piece earlier in order to satisfy outside pressure to isolate all
"how-to" stuff in the dev-manual. Doing this put a "conceptual" blurb
about x32 in the new concepts-manual. It has been decided that x32
is not a concept. It really does not fit into the ref-manual either.
So, I have re-combined the intro blurb of the x32 stuff back as the
beginning piece of the "Usingt x32 psABI" section in the dev-manual.
(From yocto-docs rev: 6e8240cc1a90a8d78ff456d3138c525eceea3ee3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Provided a better flow and a bit more explanation of what Bmaptool
provides.
(From yocto-docs rev: 9a02cd7281038031fc4cdea98f114b9c318947a7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I changed the path to not list "build/" as the example assumes
the user is already in that directory.
(From yocto-docs rev: c3ab6a9e53f48005de73977238c8af3e2061db8b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This involved removing the general information about layers from
the dev-manual and incorporating it into the new section of the
getting-started manual.
(From yocto-docs rev: 26438b03751948661f48fb0c023e393101b80e19)
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>
This section on BitBake syntax appeared in the Getting Started
manual. I decided that it should live with the section on
writing a new recipe.
(From yocto-docs rev: 8d83ce3e11405b2f12f27cdd117a19c4af52146a)
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>
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>
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>
