Commit Graph

62 Commits

Author SHA1 Message Date
Scott Rifenbark
4e4a9d7173 overview-manual: Updated the package-feeds.png figure
The figure was out of date.

(From yocto-docs rev: ae84cd2a09f81415e22333d179bcd146560b34da)

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
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
Scott Rifenbark
39f6b021d6 overview-manual: Updated "Sources" section with minor edits.
(From yocto-docs rev: 7cc11321fec1e9cd17f20129fbb201b7891eaf60)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:59 +01:00
Scott Rifenbark
bbd6856b2f overview-manual, mega-manual: Updated figures
Updated the layer-input.png and source-input.png figures.
Had to trim them so they were tighter in the figure.  Also,
updated some context in the source-input.png figures.

(From yocto-docs rev: cad644af48b0a1cb2baeb8d2649b9aa7ccbdeda5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:59 +01:00
Scott Rifenbark
ae5e39c4d6 overview-manual, mega-manual: Updates to layers discussion for build flow
The "Metadata, Machine Configuratrion, and Policy Configuration"
section discusses the three types of layers fed into the OpenEmbedded
build system workflow figure.  I updated the figures and text
supporting this discussion.  The figure had to be moved to the
mega-manual/figures folder also.

(From yocto-docs rev: 39dd671333f7b3df616920aab08e01c926deca1c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:59 +01:00
Scott Rifenbark
98c0b1ea5d overview-manual: Updates to "User Configuration" section.
This section was pretty out of date.  I have updated many areas
of the text.

(From yocto-docs rev: 640cdc7fb9d4f93c86b907d631e4f90b261d5ea1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:59 +01:00
Scott Rifenbark
7f2615b124 overview-manual, mega-manual: Updated user-configuration.png image
This image was out of date.  I updated it.

(From yocto-docs rev: feb287a72201363c43607508d2e8f1da3993f93f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:59 +01:00
Scott Rifenbark
8d7b8798d5 overview-manual: Updates to "OpenEmbedded Build System Concepts"
I removed the less than pretty build process figure and swapped
in the more aesthetically pleasing one.  Also, am refering to
the figure as the "general workflow figure".

(From yocto-docs rev: 093f1337131bc658d6afd1b56fb3661a76751aad)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:59 +01:00
Scott Rifenbark
f0bd4e42a4 overview-manual, mega-manual: Removed bitbake workflow figure
This version of the figure was not as cool looking as the other
version, which is preferred.  I have removed it.

(From yocto-docs rev: ed0346b00ee6b47d90efedd1dd69e4a92a42afe9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:59 +01:00
Scott Rifenbark
e24c3ab549 overview-manual: Bolstered the "Layers" section in the concepts chapter.
This section was really sparse for being in the concepts chapter of
this manual.  I added some more text to it.

(From yocto-docs rev: 9369ba5292126957f89f8b96e06bc2492825c54b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:59 +01:00
Scott Rifenbark
3ed721c919 overview-manual: Updates to "Components" section.
I changed the "Metadata (Recipes)" title to simply "Recipes".
It is less confusing since the term "Metadata" is in general recipes,
classes, and configurations.  Provdided a few small edits elsewhere
in the section.

(From yocto-docs rev: 566b54f58ca7859bf860f25e433bff4b429c2507)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:59 +01:00
Scott Rifenbark
901bcea5cb overview-manual: Changed build workflow title
The section titled "Development Concepts" is really mis-titled.
It is more about the OpenEmbedded Build System.  So, I renamed the
section "OpenEmbedded Build System Concepts."  There were a couple
links all within the overview-manual.  No other place in the YP
doc set linked to that heading.

(From yocto-docs rev: 889eaf3373a80ca0978ee79ecd2ff26aefb9025b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:58 +01:00
Scott Rifenbark
a8e67bb0ef overview-manual: Added a link to OpenEmbedded-Core
(From yocto-docs rev: c4642a81045a2267ceac967b7668cb64b4db1286)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:58 +01:00
Scott Rifenbark
7b94e3ef35 overview-manual: Added intro text for the concepts chapter.
(From yocto-docs rev: 6ea1e6f016957da96d6cf8a058ec9c18c9843949)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:58 +01:00
Scott Rifenbark
9a30cafe7a overview-manual: Removed redundant paragraph.
(From yocto-docs rev: 215ed3598780737feb928bb3b515882c468dbb27)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:58 +01:00
Scott Rifenbark
f679e515f3 overview-manual: Updated checkout example for Git based on a tag.
(From yocto-docs rev: ee0021b0db85ced7a36b0f25e1c1e09a0f5b1894)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:58 +01:00
Scott Rifenbark
3a4c4c9deb overview-manual: Better wording for a workflow summary paragraph.
(From yocto-docs rev: db3679a4ac22964302e4ff1b16856c25a7ce69fd)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:58 +01:00
Scott Rifenbark
e364100e22 overview-manual: Fixed wording for use of DOWNLOADS page.
(From yocto-docs rev: 575e33179779ab147b2bfc27183f2b9a25628a5a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:58 +01:00
Scott Rifenbark
8a2db4a819 overview-manual: Added clearer instructions for downloading software
(From yocto-docs rev: df16ac0829aaf99841044de99200efdf3a03cb41)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:58 +01:00
Scott Rifenbark
c9c30d04e2 overview-manual: Grammar fix.
(From yocto-docs rev: 81515d5ba7f26c7b93548a338ca7ab8ce649e387)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:58 +01:00
Scott Rifenbark
f62a1b5e3e overview-manual: Grammar fix and link to build system added.
(From yocto-docs rev: 3130b38b638c8487032f3732afdd6954ab6bbfad)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:58 +01:00
Scott Rifenbark
5b267a7c3c overview-manual: Added a link to the "build host" term.
(From yocto-docs rev: e3bdd81857752db01c3404c2eb29792439239fa9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:58 +01:00
Scott Rifenbark
1021bc0e27 overview-manual: Fixed grammar issue.
(From yocto-docs rev: a3075cdd5a3db1883dc358f7ccd6721d89677387)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:58 +01:00
Scott Rifenbark
a24760a203 overview-manual: Added link to layers section.
(From yocto-docs rev: 8a9588d27aa86bb194e85dd6bd0c885ce96507e5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:58 +01:00
Scott Rifenbark
706bcdd045 overview-manual: Fixed grammar issue.
(From yocto-docs rev: b911f05e5e3ae7161785ca3dd5cea5ffc565b804)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:58 +01:00
Scott Rifenbark
91dfb148bf overview-manual: Removed redundant text for "build system"
(From yocto-docs rev: 513082f4d63ac618d67d35b886a0347f059a8fe5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:58 +01:00
Scott Rifenbark
0e578d24b8 overview-manual: Fixed reference to "chapter" that was "section"
(From yocto-docs rev: d40924637836043fd92a2464f38f3d97c0cbcbb7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:58 +01:00
Scott Rifenbark
40054b4933 overview-manual: Fixed link to the matchbox repo.
(From yocto-docs rev: 73ba1ab13a977c15db9d5aa7cd560006e3a4ef70)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:57 +01:00
Scott Rifenbark
4adaa35324 overview-manual: Added a link to the Toaster User Manual
(From yocto-docs rev: 5571f28452c3af9a7394924cb2509693a6f8f528)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:57 +01:00
Scott Rifenbark
5c90012aba overview-manual: Added a few links to the "Poky" term.
(From yocto-docs rev: 34007b337ae0636156d64464d39470c9f20b78f0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:57 +01:00
Scott Rifenbark
9359a102a9 overview-manual: Added a few links for "OpenEmbedded build system" term.
(From yocto-docs rev: c6c23daac976e69b7e5c1a4b42abcac33b0694e2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:57 +01:00
Scott Rifenbark
bc1e7cb1ce overview-manual: Added link to YP Compatible program section.
(From yocto-docs rev: e5361d48c0807ab2f7bc674ec615e432baff2819)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:57 +01:00
Scott Rifenbark
27ad38e33e overview-manual: Added a link to the YP workflow area from "Challenges"
(From yocto-docs rev: cf90be30c3a89a55295060bb4604a468509423ed)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:57 +01:00
Scott Rifenbark
c09c157936 overview-manual: Added links to supplemental webpage docs.
In the "Challenges" section, the bullet item about YP's steep
learning curve referenced the "what I wish I'd Known" and
"Transitioning to a Custom Environment for Systems Development"
docs.  I added links to these.

(From yocto-docs rev: 627042de38495f79d512c6b98c46193b1de0db47)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:57 +01:00
Scott Rifenbark
163e2add0e overview-manual: Added link to license information.
The "License Manifest" bullet needed a link to the License
stuff in the dev-manual.

(From yocto-docs rev: 6350d68a6c1c5432fd833930437b4e5fe502033b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:57 +01:00
Scott Rifenbark
2a44f10a36 overview-manual: Added link to release cycle
The bullet "Releases According to a Strict Schedule" bullet
mentions the release cycle.  I added a link to that section.

(From yocto-docs rev: c206c31d20aabe657863fc05274e2d533cdf7252)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:57 +01:00
Scott Rifenbark
80960a8531 overview-manual: Updated "Supports Partial Builds" bullet
Added a link into the concepts area for sstate.

(From yocto-docs rev: ac395452c3a2f34fb9775c77051b526e39fd9b4c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:56 +01:00
Scott Rifenbark
abc1dd634c overview-manual: Added meaningful links to feature bullet
The "Widely Adopted Across the Industry" bullet item did not
have good links to the YP home page.  Added them in.

(From yocto-docs rev: 8695f3e2bcc2a0d37dd8e6b113639628bffdf4b2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:56 +01:00
Scott Rifenbark
f722acdcdd overview-manual: Cleaned up other reference paragraph.
(From yocto-docs rev: add845649de2c91489dd2e920865707eb3224243)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:56 +01:00
Scott Rifenbark
ba99090189 overview-manual: Added a bullet intro topic for the new concepts chapt.
(From yocto-docs rev: 4b05fd99cfb258c56957fdf864754065a74f407a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:56 +01:00
Scott Rifenbark
8961b3d9c8 overview-manual: Updated title .PNG file
The file was stretching beyond the rendered display window such
that part of the Yocto Logo was missing.  Also had to place the
updated .PNG file in the mega-manual/figures folder.

(From yocto-docs rev: 5b73c54fcb2c3f60aee2ff7dc19c4aad102aa505)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:55 +01:00
Scott Rifenbark
f3e5f2b6f0 overview-manual, dev-manual: Cleaned up links to source repos
I was using the "/cgit/cgit.cgi/" string as part of the link to
the source repos, which uses the ENTITY "&YOCTO_GIT_URL;".  That
ENTITY is all that is necessary to get the link to work.  I removed
the other stuff.

(From yocto-docs rev: f9a63c2cc824ef05230f614e933d178469890e97)

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
4045ead450 documentation: Terminology fix for "OpenEmbedded Layer Index"
Found several instances of this being referred to as the
"OpenEmbedded Metadata Index".  Changed to "OpenEmbedded Layer
Index".

(From yocto-docs rev: 60fb601be324a350cd4d51b199915e6b72e2f9b0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:48 +01:00
Scott Rifenbark
719fcb9a48 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:17:47 +01:00
Scott Rifenbark
0fbe9cebf0 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:17:47 +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
Scott Rifenbark
f476125b50 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:17:46 +01:00
Scott Rifenbark
ae06e04cd2 documentation: Created new "Getting Started" manual.
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>
2018-02-14 15:25:29 +00:00
Scott Rifenbark
0d52f18d39 dev-manual, ref-manual: Consolidated debug info into dev-manual
Fixes [YOCTO #12370]

Moved the debug information from the ref-manual to the dev-manual
where other debug information exists.  We now have a single area
(section) that deals with various debugging techniques and tips.

(From yocto-docs rev: 95394197fc04981bf7571e581ff8a0fd9c76223f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:29 +00:00
Scott Rifenbark
e4948134a8 overview-manual: Updated "Fakeroot and Pseudo" section
I added a bit more detail and some better referencing for Pseudo
and Fakeroot.

(From yocto-docs rev: 459ba368cce50cca1c3b9b7f13b1ec59a7d933ad)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:28 +00:00