Commit Graph

167 Commits

Author SHA1 Message Date
akuster
24dab56884 documentaiton: Change author info
Update the author indo and use variables for author and email to make it
easier to change in future.

(From yocto-docs rev: 4fdf2a060705fa00b11b5a9d270f4ffa506c9927)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:24 +01:00
rpjday@crashcourse.ca
a5ac4b6fca use defined entity "YOCTO_DOCS_URL", not "YOCTO_HOME_URL"
Given the defined DocBook entity:

  <!ENTITY YOCTO_DOCS_URL "&YOCTO_HOME_URL;/docs">

replace numerous instances of the more verbose
"&YOCTO_HOME_URL;/documentation", which is a redirect, anyway.

rday

(From yocto-docs rev: 53fa17321624028b12d880bc4236fbef46675eb4)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:24 +01:00
Alejandro Hernandez Samaniego
e2053e2547 overview-manual-yp-intro: Fix CROPS link
The link used in the documentation points to a file
that no longer exists on the crops repository.

Use the poky-container repo instead since it is more
accurate and updated.

(From yocto-docs rev: c5e21f5d18f4fc069ccc05cd82819eda291fcf9d)

Signed-off-by: Alejandro Hernandez Samaniego <alejandro@enedino.org>
Signed-off-by: Alejandro Hernandez Samaniego <alhe@linux.microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:25:52 +01:00
Alejandro Hernandez Samaniego
fb1c4df08b overview-manual-development-environment: Fix CROPS link
The link used in the documentation points to a file
that no longer exists on the crops repository.

Use the poky-container repo instead since it is more
accurate and updated.

(From yocto-docs rev: 98d2a2161a30d9080bc7dea8ae7964893563b1e2)

Signed-off-by: Alejandro Hernandez Samaniego <alejandro@enedino.org>
Signed-off-by: Alejandro Hernandez Samaniego <alhe@linux.microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:25:52 +01:00
Alejandro Hernandez Samaniego
42daacc1ac overview-manual: Document the basics of WSL and create a link to the build host setup process
(From yocto-docs rev: 317059cbfcd8fdb342819b00f9f2836e44ce3d8b)

Signed-off-by: Alejandro Hernandez Samaniego <alejandro@enedino.org>
Signed-off-by: Alejandro Hernandez Samaniego <alhe@linux.microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:25:52 +01:00
Robert P. J. Day
4cae3324bd manuals: Update YP manual notes with pointer to docs ML
Update the "Manual Notes" section of numerous YP manuals with a
reference to the recently-introduced YP documentation mailing list.

(From yocto-docs rev: a10fe36c864b8f1a71c6a8eb7e1f6a4eef2f5171)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-03-11 14:41:44 +00:00
Scott Rifenbark
7e7b066085 YP 3.1 Docs: Updated Manual revision tables.
Scrubbed so subsequent releases are relevant to the
initial release only.

(From yocto-docs rev: 7bb2c4f851aa968eb05b11c5471b81962f268eba)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-12-16 23:32:33 +00:00
Scott Rifenbark
292b0cc224 YP Documentation: Set up for YP 3.1 release
* Updates to poky.ent
* Updates to mega-manual.sed
* Updates to all <manual>.xml files for date

(From yocto-docs rev: 5f752ef0193cb60cd5d46a63e99ffcd02107e0c2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-12-09 12:02:54 +00:00
Scott Rifenbark
3eb09fd737 documenation: Changed "2.8" to "3.0".
I was using "2.8" throughout the manual set instead
of "3.0".  Updated all aspects to "3.0".

(From yocto-docs rev: db19937e98c59d4d2a9ce89877be3c8e0b05991a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-23 17:15:53 +01:00
Scott Rifenbark
f3c76f8fd6 overview-manual: Fixed manual history table
Missing information for some of the releases put back in.

(From yocto-docs rev: f4c09ab9eda925c16946d9d6cf58d1e40d8f6a07)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-07-18 12:16:53 +01:00
Scott Rifenbark
ab69e1917f overview-manual: Updated SCM section
Fixes [YOCTO #10098]

I updated the "Source Control Managers (Optional)" section
to reference the "Fetchers" section in the BB manuual.

(From yocto-docs rev: 0c014fba509d3ec28236e63a7bd2355b447c4acf)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18 11:29:23 +01:00
Scott Rifenbark
820ebc43d8 overview-manual: Updated SMC section to link to fetchers
Fixes [YOCTO #10098]

I did some re-writing here and also linked over to the
"Fetchers" section, which is in the BitBake User Manual.

(From yocto-docs rev: a2ba04bcf13dd1c68cba5a79ae9e7d4c8fbcdf59)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-15 21:54:15 +01:00
Scott Rifenbark
3693f075c4 documentation: Prepared for 2.8 release
poky.ent - variables all set up for 2.8
mega-manual.sed - "2.7" replaced with "2.8"
<folder>.xml - manual revision history tables updated.

(From yocto-docs rev: 6092a9282cbd397a2f64ca74361f862ea76b0e28)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
f2c6d6c84b overview-manual: Removed all references to Eclipse
I also fixed all linking as needed.

(From yocto-docs rev: f987bc2846a2356a58934164652bb1dc59623b3b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
aed303d415 mega-manual, overview-manual: Added updated index releases figure
The index-downloads.png file changes due to "eclipse" no
longer being there.  Both the overview-manual and the
mega-manual figures folders hold this figure.

(From yocto-docs rev: ef7b8dd8d636ef0ad563d1fe1ef44227f5f89fbc)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
c18fe9eb64 Documentation: Removed customization.xsl files for Eclipse
The help files for YP manuals used in the Eclipse application
are no longer supported.  I removed the individual
*-customization.xsl files for the individual YP manuals.

(From yocto-docs rev: 8c19244298b2c95ac92a398a5b6d3aca788f075e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:40 +01:00
Scott Rifenbark
59b832f360 overview-manual: Fixed broken link to pseudo.
Link has disappeared.  I am no longer using it and am using
the article to "Why Fakeroot" to cover both Fakeroot and
Pseudo "extra information" stuff.

(From yocto-docs rev: 679c6a48a8e4bcc51bb8e97f2ba80123bdba6a5c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-04-09 22:16:06 +01:00
Scott Rifenbark
c078994c2f overview-manual, mega-manual: Updated Package Feeds diagram
The diagram had a typo in it ".ipd" rather than ".ipk".
Fixed and dropped in the figures folder for each manual.

(From yocto-docs rev: d39d196713a68df8d298f6ed0f40899bc148a323)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-25 10:44:07 +00:00
Brian Silverman
316f17fb47 overview-manual: Fixed typo.
"eSDSK" -> "eSDK"

(From yocto-docs rev: 5ececa4362e0400e01327dbe4ce25202f2c392ce)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-12 21:49:01 +00:00
Scott Rifenbark
2c0db14f94 ref-manual, overview-manual: Fixed BitBake User Manual links
Some occurrences of links to the BitBake User Manual were using
a target (i.e. &YOCTO_DOCS_BB_URL;#bitbake-user-manual).  Using
this form causes the mega-manual.sed file to not process the link
correctly for the mega-manual.  These are subtle errors and have
probably existed for some time.  I removed the target ID to fix
the problem.

(From yocto-docs rev: 701f61fd80e5103ee02efbe5eed9a8607ac9a336)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:53:11 +00:00
Scott Rifenbark
324d3ad00a documentation: Changed section title for required packages.
The title needs to use the terminology "Build Host" to be consistent
with the manual set.  I updated the title and the many links into that
section.

(From yocto-docs rev: 930030433e58e6180ee4f95e559d079c3899defc)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:43 +01:00
Scott Rifenbark
985d863023 documentation: Set up the 2.6 version of the docs
poky.ent - Edited for new variables.
<manual>.xml - Manual revision tables updated
mega-manual.sed - swapped out 2.5 for 2.6

(From yocto-docs rev: 2bae8fa18ae82a325785276acdeb1394e110d2cf)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:36 +01:00
Scott Rifenbark
cbda3472e3 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:16:35 +01:00
Scott Rifenbark
1fc547845e dev-manual: Changed "Working With Yocto Project Source Files" title
Changed to "Locating Yocto Project Source Files".  I am moving the
sections on cloning repositories out from under this section.

(From yocto-docs rev: 3889aadab9b603097b6cc5b7afb9d0066021106c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:35 +01:00
Scott Rifenbark
51c74acdad overview-manual, dev-manual: Moved licensing how-to stuff to dev-manual
The section on licensing in the overview-manual was really "how-to"
information.  I moved this to a new section in the dev-manual for
"working with licenses".  I fixed some references in the ref-manual and
in the bsp-guide as well.

(From yocto-docs rev: f150a1ea2da900aae88fc5fa60f4115cc213ba2d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:34 +01:00
Scott Rifenbark
88c6050ad2 overview-manual, dev-manual: Moved Wayland and Weston
The Wayland and Weston topic moved from the overview-manual to
the dev-manual.  The topic was really a "how-to" topic and not
a concepts topic.

(From yocto-docs rev: b0f20a67c99590c48d595f4e572339bb5b6b83b3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:34 +01:00
Scott Rifenbark
3564ddf02c overview-manual, dev-manual: Moved sstate debug tips sections
Two sections at the end of the shared state concepts section
in the overview-manual are really task sections.  I took those
and created a couple new sections in the dev-manual to house
those topics.

(From yocto-docs rev: 86382e7873d796f44554c8e04d3bd8091d350f51)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:34 +01:00
Scott Rifenbark
dbdc897ca9 overview-manual: Updated "Invalidating Shared State" section
Removed "OpenEmbedded" in the string "OpenEmbedded build system."

(From yocto-docs rev: d44b370b0fb993c32c9dfe3515188fa9e7ff2437)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:34 +01:00
Scott Rifenbark
fd7f63eb57 overview-manual: Updated "Shared State" section.
Added the line with "stamp-extra-info" flag to the example from
the deploy.bbclass.  This line was missing or it had been added
since the original writing of this section.

(From yocto-docs rev: 50f5482c2132235962d4ab48d0d7263628df1728)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:33 +01:00
Scott Rifenbark
ad44dc9b7c overview-manual: Updated "Cross-Development Toolchain Generation"
I made some small edits to this section.

(From yocto-docs rev: a2cc355c1bdfbf10f86f8d4994cc81dfb12d8f87)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:33 +01:00
Scott Rifenbark
50c83e8b70 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:16:33 +01:00
Scott Rifenbark
cb244d438a overview-manual: Minor edits to the SDK generation section.
Added the descriptions for the SDK_HOST_MANIFEST and
SDK_TARGET_MANIFEST variables.

(From yocto-docs rev: 212d6c5b3290016431604e67dfb27a1408ac0463)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:33 +01:00
Scott Rifenbark
99c4743469 overview-manual, mega-manual: Updated the sdk figure
Added the manifest files to the figure and the associated variables.
Also added the test files.

(From yocto-docs rev: cfba55462d1c37ef2ff6454890da64a40f9c3607)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:33 +01:00
Scott Rifenbark
2eee77ccf4 overview-manual: Minor wording changes to the "Images" section.
(From yocto-docs rev: a3e825e6086ec7674641658cc956020e3e1cd9dd)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:33 +01:00
Scott Rifenbark
a934764b97 overview-manual, mega-manual: Updated the Images figure
I needed to add some italic formatting for variable type strings.

(From yocto-docs rev: afc6d2d10081f9e9d940075c03b3e704b37cf13b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:33 +01:00
Scott Rifenbark
b20454dbdf overview-manual: Updates to the "Images" section.
Some minor rewrites.

(From yocto-docs rev: 71cbc1c389389ffac9e59faacdc56d3ea05facd7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:32 +01:00
Scott Rifenbark
6f90c96872 overview-manual: Updates to "Setscene Tasks and Shared State"
Updated with a few minor wording changes.  Tried to get a little
more active from some of the passive wording.

(From yocto-docs rev: 7dcd8117e3ea40d4b3c1ee5c3b1ea3c2bd29893a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:32 +01:00
Scott Rifenbark
bd3df79121 overview-manual: Updated text for Image and SDK generation.
General improvements to both sections.

(From yocto-docs rev: 977fdeaf1258613c3dfc41d78c8125fdba9b2a24)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:32 +01:00
Scott Rifenbark
1211c01f82 overview-manual, mega-manual: Updated image generation image
The figure for image generation of the BitBake process
needed some enhancing.

(From yocto-docs rev: fc978663a7962d1515d4f47abe8ae522b9e24ce1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:32 +01:00
Scott Rifenbark
a35bdbeb06 overview-manual, mega-manual: Updated SDK generation image
The image needed a little bit of clean up.

(From yocto-docs rev: d4fb680be194b7f9b192e06f0081a09504649633)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:32 +01:00
Scott Rifenbark
173f158121 overview-manual: Updated the "Package Splitting" section.
Rewrite included the "do_populate_sysroot" task and a bunch of
STAGING_DIR_* variables.

(From yocto-docs rev: 53484d4982a41f83ac9355aada46526b5d05f64a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:32 +01:00
Scott Rifenbark
6a70c9db88 overview-manual, mega-manual: Updated package splitting figure
More changes to the "analysis-for-package-splitting.png" figure.
I needed to work in "do_populate_sysroot" task and several
STAGING_DIR_* variables.

(From yocto-docs rev: fcb88024a7dfff1b6cca49770f67bf4c1f548362)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:32 +01:00
Scott Rifenbark
760e435e32 overview-manual: Changed title for configure/compile section.
The stage of the BitBake workflow is really "Configuration, Compilation,
and Staging".  I updated the title to be such.

(From yocto-docs rev: 4aab6d001119aa8c52e09ef0f6f66694719add29)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:32 +01:00
Scott Rifenbark
4f8364c056 overview-manual, mega-manual: Updated the config/compile figure
The figure had the wrong hierarchy for the "image", "recipe-sysroot",
and "recipe-sysroot-native" folders.  Moved out a level.

(From yocto-docs rev: e1f45b666b1cd589cee9c9ae6dba01467b991ef9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:31 +01:00
Scott Rifenbark
dd566a4dad overview-manual, mega-manual: Updated the package splitting figure.
Figure was out of date.

(From yocto-docs rev: 5b56862ec39fc05299cd6d468f13f75b74c3b800)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:31 +01:00
Scott Rifenbark
2029d463a7 overview-manual: Updated the "Configuration and Compilation" section
This section needed some verbiage tweaks.  Nothing major.  Just a
few modifications to help clarify some areas.

(From yocto-docs rev: 9deabf424387fd1441882ce8cf28ea69421ea237)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:31 +01:00
Scott Rifenbark
380dfcbd8f overview-manual, mega-manual: Updated Config and Compile figure
The "configuration-compile-autoreconfig.png" figure was badly
out of date.  It was not showing the two sysroot directories
and did not use the $BPN variable.  I have updated the figure
and placed in both the overview-manual/figures area and the
mega-manual/figures area.

(From yocto-docs rev: dba3b2b65f18870229dcb3dbcb8fadc099165894)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:31 +01:00
Scott Rifenbark
e1774e2023 overview-manual: Small revisions to "Patching" section.
(From yocto-docs rev: 081a60766b67e8822e0c841f3259ff633580149c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:31 +01:00
Scott Rifenbark
23d93c7bed overview-manual: Added a link to the do_patch task.
(From yocto-docs rev: 934de6a59cef6a7b80530de1ccbe7006bb196238)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:30 +01:00
Scott Rifenbark
02f9805957 overview-manual: Updated "Patching" section.
This section presents a deep dive into the patching phase of the
build process.  I removed the vague "apply=yes" reference and added
more references for the reader to read and learn about patching.

The bit about the SRC_URI parameters (i.e. "apply") is going to be
covered in the do_patch documentation since that is the task that
handles that stuff.

(From yocto-docs rev: 5a2c98543ccc9ed24d16bb9442b674532940c0da)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:30 +01:00
Scott Rifenbark
03a7ed331d overview-manual: Increased viewport for patching.png image.
(From yocto-docs rev: fb8419753846e391dfc1b2dd5973eaff7627c57a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:30 +01:00
Scott Rifenbark
712b171f32 overview-manual: Converted paragraph on figure to note
The paragraph at the end of the section about the file
hierarchies is better cast as a note.

(From yocto-docs rev: 4e8a33be61ea1ea5db12fc5fc97832393213fb5d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:30 +01:00
Scott Rifenbark
bb1f84ea7b overview-manual: Updated the "patching.png" figure
The figure had a bad "PN" variable being used in the "S" directory.
This needed to be changed to "BPN".

(From yocto-docs rev: beafc55eb3646ecb96929e44538de952207f0b76)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:29 +01:00
Scott Rifenbark
86bac90936 overview-manual, mega-manual: Updated source-fetching.png figure
The figure was incorrect. Replaced the PN variable with BPN for
the "S" directory.

(From yocto-docs rev: 440edcdae932a83b6c32b51e85d97178a77b4bed)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:29 +01:00
Scott Rifenbark
304254e8ea overview-manual: Updated "Source Fetching" section.
I scrubbed through this section and provided much better
explanations of the inside workings of BitBake fetching source
with building recipes.  During that, I fixed an error where
the PN variable was being used rather than the BPN variable.

(From yocto-docs rev: 5765987259ac46f140e099d8e1da2ab33f006d36)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:29 +01:00
Scott Rifenbark
1177362b09 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:16:29 +01:00
Scott Rifenbark
588e353a1e 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:16:28 +01:00
Scott Rifenbark
0c245e1774 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:16:28 +01:00
Scott Rifenbark
e7a4c72024 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:16:28 +01:00
Scott Rifenbark
817625eb24 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:16:28 +01:00
Scott Rifenbark
15353f7d81 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:16:28 +01:00
Scott Rifenbark
06c575c711 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:16:28 +01:00
Scott Rifenbark
fa88ecd681 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:16:28 +01:00
Scott Rifenbark
d512c29f58 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:16:28 +01:00
Scott Rifenbark
1a39277269 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:16:27 +01:00
Scott Rifenbark
5b3d2f32a2 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:16:27 +01:00
Scott Rifenbark
917501d060 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:16:27 +01:00
Scott Rifenbark
3273801afe 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:16:27 +01:00
Scott Rifenbark
3f3f0c66b9 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:16:27 +01:00
Scott Rifenbark
6b0b959f1e 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:16:27 +01:00
Scott Rifenbark
eecd735518 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:16:27 +01:00
Scott Rifenbark
ee848d0ebd 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:16:27 +01:00
Scott Rifenbark
79e26ef05f 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:16:27 +01:00
Scott Rifenbark
077ecef3fb 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:16:26 +01:00
Scott Rifenbark
9d7d760daf 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:16:26 +01:00
Scott Rifenbark
0b87a83412 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:16:26 +01:00
Scott Rifenbark
09f6888973 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:16:26 +01:00
Scott Rifenbark
2b81f82edd 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:16:26 +01:00
Scott Rifenbark
558c89900f 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:16:26 +01:00
Scott Rifenbark
bf6ec42615 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:16:26 +01:00
Scott Rifenbark
f3d38e9628 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:16:26 +01:00
Scott Rifenbark
d7a97a61e7 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:16:26 +01:00
Scott Rifenbark
aa870e0071 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:16:26 +01:00
Scott Rifenbark
153f7df207 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:16:26 +01:00
Scott Rifenbark
e546355fac 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:16:26 +01:00
Scott Rifenbark
91ddbcf1b9 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:16:25 +01:00
Scott Rifenbark
51266a5498 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:16:25 +01:00
Scott Rifenbark
d665d7c828 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:16:25 +01:00
Scott Rifenbark
7d1f278d00 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:16:25 +01:00
Scott Rifenbark
5d8247761d 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:16:25 +01:00
Scott Rifenbark
59f84122aa 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:16:25 +01:00
Scott Rifenbark
962cdcd771 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:16:25 +01:00
Scott Rifenbark
554abf5d94 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:16:25 +01:00
Scott Rifenbark
bb49980a12 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:16:25 +01:00
Scott Rifenbark
34d817ffb7 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:16:25 +01:00
Scott Rifenbark
33b4b22b68 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:16:24 +01:00
Scott Rifenbark
7b582bc9a0 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:16:16 +01:00
Scott Rifenbark
0ee7583e85 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:16:14 +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
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