Commit Graph

4803 Commits

Author SHA1 Message Date
Scott Rifenbark
cfc64279f0 dev-manual: Removed writer note about needing a figure.
Nobody provided a figure for me for this section, which would
have been nice.  So, I have generalized the text to work
without that detail.

(From yocto-docs rev: 7570167196c26c9eb08e97d1350a715bff37c75f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:14 +01:00
Scott Rifenbark
feda259b89 dev-manual: Fixed grammar... missing word.
(From yocto-docs rev: 37cf33513896f2cf9accf801b0847d9f132fc06a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:14 +01:00
Scott Rifenbark
901e63c0f6 documentation: Cleaned up links to the source repositories
I was using the ENTITY with "cgit/cgi"/ appended to the end.
The appended part is not necessary.  Removed it.

(From yocto-docs rev: 64593694d62c99cbe2897804c04fea24110ee861)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:14 +01:00
Aurelio Jargas
a2cf4fd984 mega-manual.sed: Improved readability
Using the "@" character to de-specialize the "/" character.
This change makes the file more readable.

(From yocto-docs rev: d15c9ce6cc365768677cdd40a8859bb96aad7dc4)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:14 +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
d6755387a0 overview-manual: Scrubbed links and fixed a few
Found some mangled links in various spots that were causing the
mega-manual.sed file issues.

(From yocto-docs rev: 405a92f934bf7e209f3b8a543e63a1b4c693af29)

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
518ef44f61 brief-yoctoprojectqs: Added customization file for eclipse
this file was accidentally dropped during all the manual
reording operations.  I have restored it.

(From yocto-docs rev: 5c1244f18ede1af0a540687cfb5d9071fbb3c1c0)

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
5e82a9d95e overview-manual: Review feedback applied
Minor wordings based on Stephano's feedback.

(From yocto-docs rev: 4aa7aa0e9c7d8e554771743ecabdf0e64f3884e0)

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
7105c52799 mega-manual.sed: Added overview manual and extra subst.
Updated the script to process the overview-manual strings
found in the mega-manual.  These changed due to the folder
chaning from "getting-started" to "overview-manual".

Additionally, I discovered a single occurrence of a linked
reference to the mega-manual that was in the mega-manual.
This is not ideal.  That link needs to be a link in the
ref-manual where it originates.  However, the link in the
mega-manual should not link to itself.  That link needed
processing just like all top-level book links in the
mega-manual.  The link should be removed.  I added a single
substitution operation at the end of the file to handle this
lone case within the mega-manual.

(From yocto-docs rev: 57ebdb1cb10a4df0d69316d1f116d7804199ae90)

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
c555881ac8 poky.ent: Added YOCTO_DOCS_OM_URL entity
The variabe for the "getting-started" manual goes away and is
replaced by this one for the new "overview-manual."

(From yocto-docs rev: 45fc9beac6db4c40c3660fc9e54cc11e9c1f96c4)

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
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
e5dfa82d45 bsp-guide: Removed redundant word.
(From yocto-docs rev: 199f892100f352f7c190aa3d7bac1b4a5e44dfb2)

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
ea5a161850 brief-yoctoprojectqs: Fixed broken link
Found a link to a deprecated "overview" manual.  Replaced it with
the proper ENTITY to the getting-started manual.

Removed the ENTITY to the old "overview" manual.

(From yocto-docs rev: 891e4902052743833c422e6a557c93de42ed892d)

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
b8bdf61ad1 yocto-project-qs: Removed this manual.
No longer part of set from 2.5 on.

(From yocto-docs rev: edf059871a201179e8dab90746eb7e9eece65eb9)

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
d937581c8a Makefile: Removed yocto-project-qs
This file is not part of 2.5.

(From yocto-docs rev: a0ad3a90869c7dca729cce7db5fb7004e0272211)

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
ca3325e800 concepts-manual: Removed chapters.
Do not need these chapters any longer.  The manual is going away
and these chapters were organizational for the book and do not
provide any new information for the getting-started.

(From yocto-docs rev: 47e64fbee86960009968478099e9399f673bda9d)

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
d1119aaec2 mega-manual: removed chapters from concepts manual
these chapters were sucked into the getting-started manual but
now are no longer even needed there.  The chapters are
organizational for the old concepts-manual and provide nothing
for the getting-started.

(From yocto-docs rev: dd97d06039e3fd6bcbbccafa99f4d29ce041ae70)

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
f522437e13 getting-started: Moved concepts-manual-concepts.xml to getting-started
This chapter in now in the getting-started manual.

(From yocto-docs rev: 206c4e2117cc3b404c81ac66f391cee68db4a1c2)

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
890324549b mega-manual.sed: Removed the concepts-manual.
This manual will not exist.  I deleted the two lines that process
links in the mega-manual for the concepts-manual

(From yocto-docs rev: 49530e16b19b8f24782c15fe7daf68e0e0444e39)

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
e30db5ac75 mega-manual: Removed the concepts-manual.
The two chapters have been integrated into the current
getting-started manual.  Concepts manual is no longer in
existence.

(From yocto-docs rev: f8ee299901acb61d0e638ce9e36f30c5924f36d4)

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
f32995b20e poky.ent: Removed the ENTITY for the concepts-manual.
Removed the YOCTO_DOCS_CM_URL from the mix of things.  The manual
will not exist.

(From yocto-docs rev: d97df11478566654d95f02b6fe61eaa0068afb5f)

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
75b90c604b Makefile: Removed concepts-manual
This manual will not see existance.  I put the list of .png files
from this manual into the existing getting-started manual as that is
where the topics will now go.

(From yocto-docs rev: 22c2de06baf96120cbc830540e818599ce0ac07b)

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
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
d5951b4892 getting-started: Added figures from old concepts-manual
The concepts-manual is going away for 2.5.  It is being sucked back
into the getting-started from where it came after originally being
moved out of the ref-manual.  I have moved all the figures from the
concepts-manual to the figures folder of the getting-started
manual.

(From yocto-docs rev: 6a95ab558964f2833d6b214791be94cb87305926)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:10 +01:00
Kristi Rifenbark
db17061d3b 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:16:10 +01:00
Scott Rifenbark
2170916ff9 dev-mnaual: Changed "Dockers" to "Docker"
(From yocto-docs rev: af6bf8474462584b183005ce51fec42efb94e232)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:10 +01:00
Scott Rifenbark
f1df143c49 dev-manual: Fixed grammar error.
(From yocto-docs rev: a0f045418cb378ec07725dfd6de20b5d7ce33239)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:10 +01:00
Scott Rifenbark
6e31e66dcc dev-manual: Corrected "Docker" typo.
(From yocto-docs rev: 5615e6803dbbe64e66cced29f44f1cf9e94fdf38)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:10 +01:00
Scott Rifenbark
7198dde661 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:16:10 +01:00
Scott Rifenbark
dc5690178e 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:16:10 +01:00
Scott Rifenbark
59af2e1787 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:16:10 +01:00
Scott Rifenbark
63e53d7c27 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:16:10 +01:00
Scott Rifenbark
e210381588 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:16:10 +01:00
Scott Rifenbark
5ce8b42b5f 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:16:10 +01:00
Scott Rifenbark
95e451e748 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:16:10 +01:00
Scott Rifenbark
c847ddc104 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:16:09 +01:00
Scott Rifenbark
0490334469 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:16:09 +01:00
Scott Rifenbark
20a5fecdb4 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:16:09 +01:00
Scott Rifenbark
ede16868be concepts-manual: Updated Image Generation section.
Added wording to note that the rootfs might be compressed
depending on the IMAGE_FSTYPES setting, which would have to
actually do compression.  Also, fixed examples of "do_image_type"
and "do_image_ext4" so that there is no "[depends]" as part
of the example.

(From yocto-docs rev: 18ecdc6dd8722212c94000950841a4c06d3e48aa)

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
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
7306ab1ba2 mega-manual.sed: Improved readability for strings in .sed file
The escaping of the double quote characters is not necessary
in the mega-manual.sed file, which processes the links in that
large HTML document.  I have removed them.

Authored-by: Aurelio Jargas <aurelio@aurelio.net>
(From yocto-docs rev: 640a52c74750b9148116171cfa8a2cca388f6d7c)

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