161 Commits

Author SHA1 Message Date
Scott Rifenbark
055ee2f780 sdk-manual: Edits to "Sharing Files Between Recipes"
Added a cross-reference to the term "build host".  Corrected
a subject/verb grammar error.

(From yocto-docs rev: 4f5c3a49555601d8a20da1b629a46bde03866e78)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:38 +01:00
Scott Rifenbark
2186084192 sdk-manual: Edits to "Finding Logs and Work Files"
This section was poorly organized with a mile long sentence as
the opener.  Fixed it.

(From yocto-docs rev: c2496c7aebc056395b7a796501cf6cd5f6519fff)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:38 +01:00
Scott Rifenbark
1e3fedacb3 sdk-manual: Added links to sample tasks to "Working With Recipes"
(From yocto-docs rev: 4c59f516de8edff7eb9ae27194c9af27a853dfa9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:38 +01:00
Scott Rifenbark
6e9bfc5901 sdk-manual: Edits to "Adding Node.js Modules"
Fixed a few sentences up by providing clearer text.

(From yocto-docs rev: 64af3ec2c380d73dc863b2aea7878544b472218d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:38 +01:00
Scott Rifenbark
6f5ad8b8d3 sdk-manual: Edits to "Adding Native Tools"
Added a cross-reference link to the term "bulid host" and removed
the redundant word "system".

(From yocto-docs rev: 258086ab4af3739a845d6031e5875c13084e7eb0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:38 +01:00
Scott Rifenbark
85645c7dc2 sdk-manual: Edits to "Adding Makefile-Only Software"
Fixed some prose in various places.

(From yocto-docs rev: f368408a3764ad9248478383236261066772f0b6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:38 +01:00
Scott Rifenbark
b598e35761 sdk-manual: Edits to "License Detection"
Updates to prose for better understanding.

(From yocto-docs rev: 5c4384d4311d8fbedad0eb9ebb77427a1dbbbdcf)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:38 +01:00
Scott Rifenbark
ace3fe02d1 sdk-manual: Edits to "Dependency Detection and Mapping"
Updated various prose for better understanding.

(From yocto-docs rev: 13d5330dc5de232311fbb43d5041d0f7f11de6c0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:38 +01:00
Scott Rifenbark
da9a1145d6 sdk-manual: Edits to "Name and Version"
Poor writing left over in here.  Updated some of the prose.

(From yocto-docs rev: 9812ce3f1b6a4931a1b8b634a6d1f69c0e96c957)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:38 +01:00
Scott Rifenbark
d2aece029e sdk-manual: Edits to "A Closer look at devtool add" section.
Corrected some prose to be clearer.

(From yocto-docs rev: 9ab0ef0c00792f07f3b45466baeafe30199f048f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:38 +01:00
Scott Rifenbark
a36e4fea7a sdk-manual, mega-manual: Updated devtool add and upgrade figures
Took out the $TMPDIR part for the output and left more generically
as "Build Output".

(From yocto-docs rev: 90b3c468dbea19c87340bd234ffe1b263ffa1e4f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:38 +01:00
Scott Rifenbark
12c05ab1b0 sdk-manual: Changes to the devtool upgrade section.
Edits to improve this section.

(From yocto-docs rev: af0084dd82b7dcec73db5a1b4e6760b7b7738bf9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:38 +01:00
Scott Rifenbark
1b8867ad08 sdk-manual, mega-manual: Updated the devtool upgrade flow diagram.
Added more detail at the top for how the local recipe interacts
with the Upstream Source.

(From yocto-docs rev: fea704bc485c53bf27ce43f5d1d491bf652ddc9c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:38 +01:00
Scott Rifenbark
d7221d823c sdk-manual: Edits to the devtool add workflow section.
Minor edits from the read-through.

(From yocto-docs rev: ee25d5a607591823401b6c7e8b9b7dccf707f996)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:38 +01:00
Scott Rifenbark
464af1a042 sdk-manual, mega-manual: Updated devtool add flow diagram
Added more detail on how the upstream source or files from
srctree are located.

(From yocto-docs rev: 11c4679ee91afbb96a7ea82f6e32c90b5e3a0d66)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:38 +01:00
Scott Rifenbark
9435650a71 sdk-manual: Updated devtool add workflow section.
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: b55ccf14a9a4b8948a920f0942da1fdda93b2e9e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:38 +01:00
Scott Rifenbark
c60a06bc65 sdk-manual: Edits to section on running the sdk installation script
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: fa60c255a12bd3dd79da4a77c3150937eeb4e201)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:38 +01:00
Scott Rifenbark
b369e613a1 sdk-manual: Updates to "Running the Extensible SDK Environment Setup Script"
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: a03f00142f82dd4b2b10332f2fe1c71c2bdd8c35)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:06 +01:00
Scott Rifenbark
ee37ab28c6 sdk-manual: Updated the "Installing the Extensible SDK" section.
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>
2018-05-24 17:18:06 +01:00
Scott Rifenbark
e53bec948f sdk-manual: Minor edits to the intro chapter.
(From yocto-docs rev: 706b4adfd925d247da2ce7405f12ce1e05666a9e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:06 +01:00
Scott Rifenbark
4b3c17707b dev-manual: Moved the "Simple Build" section
I had a section on building an image up in chapter that talks about
getting set up to use YP.  I moved the build section to a new parent
section that will hold topics on building various things.  I renamed
the section to "Building a Simple Image".  I had to fix several links
in the sdk-manual, overview-manual, and dev-manual.

(From yocto-docs rev: c119fc7c6148e7b08acad374fe2981842e9462a3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:05 +01:00
Scott Rifenbark
45028b41f3 dev-manual: Changed title to remove redundancy
The "Setting Up the Development Host to Use the Yocto Project" title
changed to "Preparing the Build Host".  Fixed links in a lot of
other manual.

(From yocto-docs rev: 00e487e01a0e2a16f5b8d786b3124cbe5115b38b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:04 +01:00
Scott Rifenbark
372e47e927 documentation: Removed release date ENTITY
Now that 2.5 has released, I replaced the ENTITY variable used for
the moving month and year with the actual release month and year
(i.e. May 2018).

(From yocto-docs rev: 2d6e8ddce4fce0c405d2aea69cea2a5b262410f7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:04 +01:00
Scott Rifenbark
381cfb71e1 sdk-manual, mega-manual: Updated devtool modify workflow diagram
Added detail for the step one.  Clearer.

(From yocto-docs rev: ef95d547180ce53fade7a3764f8d362422472c7a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:01 +01:00
Scott Rifenbark
4a2f73dc28 sdk-manual: Updated devtool modify workflow section.
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>
2018-05-24 17:18:01 +01:00
Scott Rifenbark
92de2a42c3 documentation: Added ENTITY variable to track a release date and year
(From yocto-docs rev: 65a87312f541e2f2b01fa1918f7a12da607fe7ab)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:00 +01:00
Kristi Rifenbark
ce451add35 sdk-manual: Updated Eclipse Oxygen plugin instructions
(From yocto-docs rev: 860f852b0aa99c9c65175fe5fe5035ea0bd26d63)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:55 +01:00
Scott Rifenbark
6ed08ab9ce sdk-manual: Removed redundant link to "Build Directory"
(From yocto-docs rev: 9ce5617e008ce18656cc04608c50186f3d3b05bf)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:49 +01:00
Scott Rifenbark
a345563928 sdk-manual: Scrubbed "Neon" occurrences from the Oxygen chapter.
(From yocto-docs rev: 5c53a75af70a6c6ddaaf5b1d298ea129006f2952)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:49 +01:00
Scott Rifenbark
cd8aa05113 sdk-manual: Fixed minor wording problem.
(From yocto-docs rev: 030fa276d1fc462b321e43547a6da03ca05d590e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:49 +01:00
Scott Rifenbark
04b21d6e0c sdk-manual: Fixed bad title in link.
Link was going to the right place but had an old chapter title
name.

(From yocto-docs rev: 57a5d25180429a97d47678c0782198623bc06eef)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:49 +01:00
Scott Rifenbark
0b07e5c00d 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:17:47 +01:00
Kristi Rifenbark
cc6a01da0e sdk-manual: Updated "Installing the Neon Eclipse IDE"
(From yocto-docs rev: e6e6cd146bb821d544b1b9a43307ecd3034f3e52)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:45 +01:00
Scott Rifenbark
816fd8faca sdk-manual: Fixed reference to the Neon Appendix.
The link to the appendix was referencing Appendix C instead of
Appendix D.

(From yocto-docs rev: b8b4ffe14f74ef0a76289258ae17a3843363397d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:45 +01:00
Scott Rifenbark
b95b9595ff sdk-manual: Removed non-eclipse option for Eclipse flow
The step in the general Eclipse IDE workflow has a step that tells
the user to "Create and Build Your Application."  I had a sentence
in that step that suggested if you were not using Eclipse to follow
some sort of procedure.  The whole idea of this flow is to be
working within Eclipse.  I removed that sentence.

(From yocto-docs rev: 83c35e9bb7190464af840822f5dd66d84e15ec64)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:45 +01:00
Scott Rifenbark
c7bc648e65 sdk-manual: Added cross-reference to QEMU Emulator.
(From yocto-docs rev: 97b070efdadaec645df24416d61c184065d4b96b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:44 +01:00
Scott Rifenbark
c94c6b746d sdk-manual: Formatting change to list.
(From yocto-docs rev: 3f0ead6ce135ae8f92fa9cded676bb558424628c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:44 +01:00
Scott Rifenbark
cab4efa208 sdk-manual: Fixed capitalization issue in a list.
(From yocto-docs rev: 861ce526456e2ee2f924b57a469e8c8fdb6bb768)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:44 +01:00
Scott Rifenbark
b9f459b447 sdk-manual: Updated heads for list on Eclipse development
The list headings were not conforming to the capitalization rules
for lists used in the YP manual set, which is significant words
are capitalized in a bolded item of a bulletted or numbered list.

(From yocto-docs rev: af60763b7daccb6af22b4761f6b8370ea1956714)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:44 +01:00
Scott Rifenbark
32ddfa7061 sdk-manual: Updates to the "Using SDK Toolchain Directly" chapter
Some minor updates here.  Mainly, bring a list into conformance
for use of capitalization in the bolded item heads.

(From yocto-docs rev: a9c9bb36caa146b0ff8338cb1fad850d75a64997)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:44 +01:00
Scott Rifenbark
dc1d67be95 sdk-manual: Updated SDK installation script naming explanation.
Updated the various fields for what goes into the name of one
of these *.sh files pulled from the download sites.

(From yocto-docs rev: 4b326ae834d50607062c2f29c27fccd496489eb6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:44 +01:00
Scott Rifenbark
f1a7cb96a5 sdk-manual: Updated note about some tools being deprecated
The note was written such that it appears some performance tools
were just recently deprecated with this release of the Eclipse
Yocto Project plug-in.  This is not the case.  I updated the
note wording to simply state that those tools are deprecated
with the plug-in.

(From yocto-docs rev: 4e8aa076ec009c71d7ceeda5c64a617e1c2696fb)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:44 +01:00
Scott Rifenbark
8f8215dcf8 sdk-manual: Updated Eclipse trademarking usage
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>
2018-05-24 17:17:44 +01:00
Kristi Rifenbark
8283724ee3 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:17:43 +01:00
Scott Rifenbark
bd6580fc18 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:17:43 +01:00
Kristi Rifenbark
3e739f1fdc sdk-manual: Fixed duplicate link
(From yocto-docs rev: 53da7ae95f499bcfb80d4f04b834bf6ade71d2ff)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:42 +01:00
Scott Rifenbark
01d53451fb 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:17:42 +01:00
Kristi Rifenbark
ffd1ad245f 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:17:41 +01:00
Kristi Rifenbark
da0ebd28f6 sdk-manual: Removed Mars Appendix
Fixed [YOCTO #12417]

Deleted the appendix.xml file.
Updated the mega manual .xml file to not include
the Mars appendix file.
Updated the sdk-manual.xml file to not include the
Mars appendix file.

(From yocto-docs rev: e7752c3db1aec8d5143e78aab44ec5afaaaf9c76)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:41 +01:00
Scott Rifenbark
cf40ca7f5d sdk-manual: Updates to the devtool upgrade flow section.
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>
2018-03-25 09:41:11 +01:00