Fixes YOCTO #13079
Bug is about making sure the section on the devtool command
talks about oe-local-files. Two devtool commands (modify
and upgrade) needed to mention the role of the oe-local-files
area and how it is used during these commands. I updated the
appropriate sections:
* Use devtool modify to Modify the Source of an Existing Component
* Use devtool upgrade to Create a Version of the Recipe that
Supports a Newer Version of the Software.
(From yocto-docs rev: 70ed68eca6dcb5b1f1b5638fd27a7b513b65661e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the "Use devtool upgrade to Create a Version of the Recipe
that Supports a Newer Version of the Software" section, we
reference "fetchers" but do not link to the section on them
in the BB manual. I added a link.
(From yocto-docs rev: 633ac78daa2ab3bdde17ecb1a203f6addd6ee4af)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Took care of links as well.
(From yocto-docs rev: a338dc13ebbcdc77fb16e36f12eb5f0e1e05187f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
unify the spacing for questions in various places
e.g. before the [Y/n] there should be a space, and before
"?" there should be none. Unify the questions where the
system expect an answer from the end user
(From yocto-docs rev: 0643b2e22273a798b96f126931885efd733e5f89)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There are two sections that deal with this topic. One is from the
standpoint of a user using a 3rd party published and installed
extensible SDK ("Applying Updates to an Installed Extensible SDK").
The other is from the standpoint of a person providing Extensible
SDKs for consumption ("Providing Updates to the Extensible SDK
After Installation"). These sections needed some closer examination
regarding fully describing what was going on. I provided some
re-writes to both.
(From yocto-docs rev: 1c60b13b5f1813d6e3688e1efce32b7f31422e86)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed some poor writing in this section.
(From yocto-docs rev: 5709c2c2c1c37166ec5df1193b58ff82bb10b4c3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Minor edits.
(From yocto-docs rev: 3ed2c1026bf03feb03001e00daec55b94d7dc35b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed a grammar error and made a few other corrections.
(From yocto-docs rev: 369a22ffe3780fd00514344f1b3b8a944305e320)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a cross-reference to the term "build host". Corrected
a subject/verb grammar error.
(From yocto-docs rev: 8763e333867d0039315f0ca0aa96fdadea676783)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This section was poorly organized with a mile long sentence as
the opener. Fixed it.
(From yocto-docs rev: c7624244e40c807d1c3cea80d2eced3cd9948019)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed a few sentences up by providing clearer text.
(From yocto-docs rev: e81984d73c05f2d722bc082a100d01c3cc0173ab)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a cross-reference link to the term "bulid host" and removed
the redundant word "system".
(From yocto-docs rev: 205d6fb6030cecb02301ec9cdc92ac908d250160)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed some prose in various places.
(From yocto-docs rev: f754969eff4c314d9f4c489cca2b3c2f8fd87fff)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updates to prose for better understanding.
(From yocto-docs rev: 44a07560845c973a0da4c27969c740d3d712d323)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated various prose for better understanding.
(From yocto-docs rev: ddbd66d7732bbc8b4940c660f8a8c941a5cc4ea2)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Poor writing left over in here. Updated some of the prose.
(From yocto-docs rev: 8f71cd997c86610dd62780f74f39dad811098540)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Corrected some prose to be clearer.
(From yocto-docs rev: c73f3d486fab555e6c6ac3dd1f5fbaf4d531ab29)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Edits to improve this section.
(From yocto-docs rev: f062882b3b3cf9c454466fa9d243284d97592bdc)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Minor edits from the read-through.
(From yocto-docs rev: d165438d3d02f3154fc59197d75ab1cb6a285320)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Had to update the figure to use "Upstream Source" labels and
fix a wrong "devtool edit-recipe" command. That new figure went into
both figures folders for the sdk-manual and mega-manual areas.
Provideds some cleaner wording.
(From yocto-docs rev: 6225d04dd0551a840d929b752225064a222962bc)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I changed the way we handle the list of exported variables resulting
from running the *.sh installation script. Rather than list them
all out (they were getting to be quite numerous), I am referencing a
few as examples and recommending the user look at the actual *.sh file
if they would like to examine the entire list.
(From yocto-docs rev: ce2c1491f4f0991cad5f8d4a220a102adb024624)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some Minor edits to this section. Also, a scrub of the list of variables
exported when running the install script. The list is out of date and
is missing many variables. I noted these in comments for now and will
add them in later.
(From yocto-docs rev: 739a2ca42ee798625492ddb51a32ad09f80aa960)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The text had not been updated to include the many architectures
now supported in the Index of Releases toolchain directories.
I added the list of architectures.
Renamed the section to a more appropriate section heading.
Verified the example and put in the latest output.
(From yocto-docs rev: a567f5101d230ef1fa4428e9c6905e9e23bd5855)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I found this section a bit loosely worded and could result in
confusion to a user ramping up with YP. I have done an extensive
rewrite focusing on exact wordings.
(From yocto-docs rev: af64c07d259e06fb13572fc224636ed240037b57)
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>
Made sure that each first occurrence in a chapter used the
"tm" mark.
(From yocto-docs rev: b7b21441b5fc009b8161902a10cfe1863d87b8a8)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Did some rewriting to add some references to other sections
in the manual set. Did some other minor clean up.
(From yocto-docs rev: 7e7be31e96a0e73e230b8596b2431716f254e027)
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]
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>
Two links that should have been to different places were overlooked.
I fixed these.
(From yocto-docs rev: a1681d065812546a573ed778141289a6b476cecd)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The section on the devtool workflow in the dev-manual was 99%
identical to what was in the sdk-manual. I have moved the
workflow procedure from the old "Model" chapter of the dev-manual
to be merged with what was in the sdk-manual. In truth, the
only things added were a note about devtool not being exclusive
to SDK development.
The result of moving (deleting) this section was that the "model"
chapter of the dev-manual went away. The devtool stuff, Quilt,
devshell, and python shell are all out now and there is no
chapter left. So, mega-manual had to be adjusted to not pull that
chapter in when building the dev-manual. I had to delete three
figures that were used in the flow. The figures were already
replicated in the sdk-manual. The figures were deleted from the
figures folder of both the dev-manual and the mega-manual.
I had to make sure all references to the old devtool stuf in the
YP doc set were adjusted.
(From yocto-docs rev: 5dbd643d31ab502df53a22229e457a03da7772b7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
I applied several nits across the manuals based on reviewer
comments. All these corrections relate to the task of shuffling
topics around that have to do with the extensible SDK and the
devtool.
(From yocto-docs rev: 9f8079adc7fa2897fd885aff8e64f9721212e9c7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Removed the note box formatting for the cross-reference
from the sdk-manual and dev-manual sections that
talk about devtool. The reference is now non-note
form and goes to the ref-manual devtool quick ref.
* Added devtool upgrade as a third item in the list that
introduces methods to use devtool.
* Fixed the working on the devtool finish step 5 for both
the dev-manual and sdk-manual.
* Renamed the new chapter that describes different projects
you can use devtool on. The focus is on using the SDK
toolchain directly.
* Scrubbed the entire sdk-manual for the term "toolchain
installer" and replaced with "SDK installer".
(From yocto-docs rev: 6d4daef49cc6d54a700a8c3965c9e8814f75d20a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I extracted the sections on Makefile, Autotools, and Eclipse into
their own new chapter. Seemed to make sense as they are projet
types for both standard and extensible SDK types. Also, swapped
the order of appearance from standard first to extensible first.
This swapping caused a bit of rewriting.
(From yocto-docs rev: 138a4d5576123da800a8fd8d99462a138ceeb743)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Did the following:
* Added the devtool upgrade flow to the SDK manual.
* Removed the devtool Quick Reference from the dev-manual and
added it as a new chapter to the ref-manual.
* Made sure all the links and cross-references work now with the
moved material.
* Updated the Make file so that the manual set builds correctly
regarding the new chapter in the ref-manual.
* Created cross-referencing notes in both the sdk-manual and the
dev-manual to the newly located devtool Quick Reference chapter.
(From yocto-docs rev: fda0bf68b3654b1b96407d552c5254657465b5fc)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I needed a new figure and a new section.
(From yocto-docs rev: d413ca7b9b946450af7c2c15ab0e68e9181517e9)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A new command devtool finish has superceded the final commands
in the SDK workflow. I updated the two figures (add and modify)
to reflect this new flow. I also updated the ordered number list
to match reality.
(From yocto-docs rev: 0ba31e730cd748d06eab8d46b38764cda5c4e3bd)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10183]
Added a new variable entry for the PACKAGECONFIG_CONFARGS variable.
With the introduction of the new PACKAGECONFIG_CONFARGS variable,
many places in the mainstream YP documentation that referenced
how to pass configure arguments using EXTRA_OECONF needed to also
make mention of this new variable. I added many cross-references
to the new variable.
(From yocto-docs rev: 00f02d45319bab90b72eab89fcb69cbe8bd05bb5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
