Commit Graph

5056 Commits

Author SHA1 Message Date
Scott Rifenbark
bf2a7a31ca sdk-manual: Edits to "Installing Additional Items Into the Extensible SDK"
Minor edits.

(From yocto-docs rev: 3ed2c1026bf03feb03001e00daec55b94d7dc35b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:46 +01:00
Scott Rifenbark
73d00d17fb sdk-manual: Edits to "Restoring the Target Device to its Original State"
Fixed a grammar error and made a few other corrections.

(From yocto-docs rev: 369a22ffe3780fd00514344f1b3b8a944305e320)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:46 +01:00
Scott Rifenbark
d527a5f7ab sdk-manual: Edits to "Packaging" section.
Edits to improve writing.

(From yocto-docs rev: 04d2df37ad718508c7f78a204d0d5e5fff431ce8)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:46 +01:00
Scott Rifenbark
c0d1ff66ee 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: 8763e333867d0039315f0ca0aa96fdadea676783)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:46 +01:00
Scott Rifenbark
130038674a 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: c7624244e40c807d1c3cea80d2eced3cd9948019)

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

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

(From yocto-docs rev: e81984d73c05f2d722bc082a100d01c3cc0173ab)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:46 +01:00
Scott Rifenbark
54e3cdcc27 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: 205d6fb6030cecb02301ec9cdc92ac908d250160)

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

(From yocto-docs rev: f754969eff4c314d9f4c489cca2b3c2f8fd87fff)

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

(From yocto-docs rev: 44a07560845c973a0da4c27969c740d3d712d323)

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

(From yocto-docs rev: ddbd66d7732bbc8b4940c660f8a8c941a5cc4ea2)

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

(From yocto-docs rev: 8f71cd997c86610dd62780f74f39dad811098540)

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

(From yocto-docs rev: c73f3d486fab555e6c6ac3dd1f5fbaf4d531ab29)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:46 +01:00
Scott Rifenbark
11e0ec39fd 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: 4b0375e3293d67e4b5be433cd6c468532fee5a30)

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

(From yocto-docs rev: f062882b3b3cf9c454466fa9d243284d97592bdc)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:46 +01:00
Scott Rifenbark
d0373e0834 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: c1d49a7c00c458b55396c0efc7a329acd870be6c)

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

(From yocto-docs rev: d165438d3d02f3154fc59197d75ab1cb6a285320)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:46 +01:00
Scott Rifenbark
ef0fdb9e27 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: 5eff4b1b68c232071814969b6367188352639f17)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:46 +01:00
Scott Rifenbark
e1769a81df 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: 6225d04dd0551a840d929b752225064a222962bc)

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
933efe0f1c 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: ce2c1491f4f0991cad5f8d4a220a102adb024624)

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
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
61a8bb03ac 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: 739a2ca42ee798625492ddb51a32ad09f80aa960)

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
63a151b874 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:16:36 +01:00
Scott Rifenbark
fc99fc952e 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:16:36 +01:00
Scott Rifenbark
5d29a2ef27 bsp-guide: Fixed MACHINE_EXTRA_RRECOMMENDS syntax in conf file example
Fixes [YOCTO #12628]

The syntax for MACHINE_EXTRA_RRECOMMENDS was off in the machine.conf
example.  I have removed that leading space, which should not have
been there.  This matches the actual file in poky now.

(From yocto-docs rev: 11e38c4c2b23f9a8ae9a0655a07af1a5682c24b8)

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
368474d740 dev-manual: Removed "newbie" chapter.
This chapter only had the stuff about submitting a defect against
YP and making a change to YP.  I moved that information into the
common tasks chapter as it is "how-to" information.  Removal of this
chapter alse required that the mega-manual.xml file be updated to
not include the chapter.

(From yocto-docs rev: 4421b1585c21a6f7862525ba972f7e765626066e)

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
9a37a3d568 dev-manual: Moved "Speeding Up the Build" and renamed it.
Renamed to "Speeding Up a Build" and moved out of the setting up
chapter to the common tasks chapter. Fixed a couple links in the
ref-manual.

(From yocto-docs rev: c53fddd353230c8ef1abc21c7a2d2b1f492f034a)

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
Kristi Rifenbark
bd4438f4a4 ref-manual: Finalized edits on the 2.5 Migration section
(From yocto-docs rev: 54259a4d4d69be73e7c614baa2a8d87faa2e3ea5)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:35 +01:00
Scott Rifenbark
e1b1f83208 dev-manual: Moved "Building Software from an External Source" section.
This section is now organized under the parent "Building" section in
the common tasks chapter.

(From yocto-docs rev: bc1bc9965cda547e45ff09a1c9e77be5e8c0a3d9)

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
0122aced5f dev-manual: Moved "Building Images for More than One Machine" section.
This section is now organized inside the parent "Building" section
in the common tasks chapter.

(From yocto-docs rev: 71be83e1ebfd2ad8606bddf852a4c06ab7d7c53d)

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
bfaf918ec9 dev-manual: Moved "Building a Tiny System"
This section is now part of the building parent section.  I have moved
it there in the common tasks chapter.

(From yocto-docs rev: a9fccb1bca8e18169d93416c7a6e17723bcf01c7)

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
16e730e638 dev-manual: Moved "Building an Initial RAM Filesystem (initramfs) Image"
This section now belongs under the parent "building" section in the
common tasks chapter.

(From yocto-docs rev: dad6029b9b45fd6ec564894ba101991fd8a2162e)

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
5c5a8e3d34 dev-manual: Moved "Building Targets with Multiple Configurations"
This is a "building" topic.  I moved it beneath the new parent
"building" section.

(From yocto-docs rev: 0426f0dd6871c8063476945b93743ffc5cfc0856)

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
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
cd9affa635 dev-manual: Pulled cloning sections up into a parent section.
(From yocto-docs rev: 68ef556831f687e25e3f4df068db4ea86bffb3b3)

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
2b56e7d4b9 dev-manual: Updated intro paragraph to exclude removed sections
(From yocto-docs rev: 886ec9153314acbdcfa510806b441ba02c0bdd2d)

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
ea1936fc02 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:16:34 +01:00
Scott Rifenbark
d38c9ba94a dev-manual: Moved section on setting up a team YP environment
This section was in the chapter on the open source development
environment.  It is better suited to be in a newly named chapter
"Setting Up to Use the Yocto Project".  I have moved it.

(From yocto-docs rev: 028f8f7a1b93a023a99ffadb01b0da699b4081c2)

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
2228249488 dev-manual: Updated intro chapter
The chapter was not the best given the new nature of the manual.  I added
better introductory wording.

(From yocto-docs rev: cb4695575c0105e0cd5e50c2132e98553babe147)

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
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
afe2d7cf45 dev-manual: Updated "Enabling Runtime Tests on QEMU"
Fixes [YOCTO #12517]

Added some qualifying information for how to generate a list of tap
devices to enable runtime tests on QEMU.

(From yocto-docs rev: 4359a355944f6cf4ec1e14ecbedc690ef37ff743)

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
c72b126bc0 ref-manual: Chanaged a link to Wayland topic.
The Wayland and Weston topic moved from the overview-manual to the
dev-manual.  The lone link to this topic was in the ref-images
chapter.  I updated the link.

(From yocto-docs rev: 6c335f8d3618e3285f91fe20aea33a1c1f1c0ddf)

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
Kristi Rifenbark
6da15e51a8 ref-manual: Formatting pass of 2.5 Migration section
(From yocto-docs rev: 50308cc7f04d3fc54c06766f85e15e76a99f0b4b)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.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