Commit Graph

1742 Commits

Author SHA1 Message Date
Scott Rifenbark
e7a5c98b5f dev-manual: Updated the section on CROPS
Final edits to this section.  The procedure is more complete now.

(From yocto-docs rev: 5dcc32917c360e32475851b2b580d3d8bc988d7e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:44 +01:00
Scott Rifenbark
46fea20b45 dev-manual: Updated link to "CROPS" to be to the GitHub area.
The original link was to a deprecated site.

(From yocto-docs rev: 067094d10a8d02d0873deb87508377e896e4f3c7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:44 +01:00
Paulo Neves
c610d310e7 dev-manual, ref-manual: Updated available names for TEST_TARGET
The documentation of available names for TEST_TARGET has been
updated to match the convention of using the class names of
controllers.

This commit was modified some to make it work.  Fixed some
formatting errors and isolated and changed missed instances.

(From yocto-docs rev: 1bec1dc38cdd1746ce6dd539f9c3e5665d12ab8e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:44 +01:00
Scott Rifenbark
3d96c5ef26 dev-manual: Edits to section on setting up CROPS
Performed some edits to bring things in line for the "build host"
terminology.

(From yocto-docs rev: 4fedbdac437691b8a0f8d56931fcaad461c7463a)

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
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
534586c571 dev-manual: Updates to "Setting Up a Native Linux Host"
I made some terminology changes to be consistent with the
"build host" term.

(From yocto-docs rev: 8e00f6453cbc470c7572f2c18e23e44ce18a7336)

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
2fcca2d645 dev-manual: Adjusted "build host" wording.
Fixed the "Preparing the Build Host" section to consistently use
the terminolgy "build host".

(From yocto-docs rev: 6199dde0611b4f077dfb2ad1ebdcc1414c4a081a)

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
84331dc67e dev-manual: Added "recommended" for choosing native linux build host.
(From yocto-docs rev: cddc649590fc6cea74a0b78a584e00e22088541c)

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
7a4d6b011f documentation: Fixed bad target ID for the dev-manual.
This fix involved a few other manuals.

(From yocto-docs rev: d2659951a458a8db773e8c1b2b86a7b109d667fa)

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
ddf18f727d dev-manual: Fixed typo in id anchor for a section heading.
(From yocto-docs rev: 05e6520843fda764f3090c7d681f8fdad5f80311)

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
3904413fcc dev-manual: Updated team development environment section.
Found several areas that needed improvement.  Made these
modifications.

(From yocto-docs rev: e2125363d39b9a54a371fc737cc9b55d66c9be59)

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
299f2e8efb dev-manual: Updates to intro chapter.
(From yocto-docs rev: a991415c8645a3ad31bf2dd20f932d7f3b4ebe18)

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
Kristi Rifenbark
2a74e8fb94 dev-manual, ref-manual: Documented NO_GENERIC_LICENSE
FIXES [YOCTO #12734]
Added a new variable description and created a new
section in the dev-manual.

(From yocto-docs rev: 854e641482171585c96ee5b9387b3e64146072b9)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-28 09:22:57 +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
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
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
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
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
Martin Kelly
8c10e2e2c9 dev-manual: New section in QEMU for workaround under KVM
As suggested in a recent mail thread by Martin Jansa, there are cases in
which QEMU under KVM will crash because of CPU feature incompatibilities
between compiled binaries and the host CPU under which qemu is run.
Although this is hard to fully escape, we should document the issue to
help people work around it.  I have taked Martin's suggested patch
and did some rewording for the new section.

(From yocto-docs rev: 6c625fcf631a82529bc58ec8fb0c18dbe13188d2)

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
d4aa681956 dev-manual: Updated "Enabling Your Layer" section.
The bblayers.conf example files were out of date.  Updated them.

(From yocto-docs rev: fd5d75604a3ad66e56c421634f349dce3e38f609)

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
5d6fc98b98 dev-manual: Updated wording for Manage Granular Level Packaging
Changed wording to be clear about how PACKAGE_ARCH is being set
when based on the Freescale MACHINE_SUBARCH variable.

(From yocto-docs rev: 76c4ad514e44755f1d4dcec61bb0a74c1b77243e)

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
b5b17600ea dev-manual: Updated managing granular level packaging discussion.
In the section that talks about building an image for multiple
machines, there was a bullet item on managing granular level
packaging.  It had an old example that used the "daisy" release
that showed how to share packages and re-use binaries.  I replaced
the example with a discussion of Freescale's "fsl-dynamic-packagearch"
class, which does this type of sharing.

(From yocto-docs rev: ddc224d6d1fe172292dfd0a17f743a1e0a4cabe6)

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
41aad59377 dev-manual: Changed Wic example paths to be consistent.
(From yocto-docs rev: 402434dd15f3116307e690ecc09db875ecabded4)

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
7319f566ea dev-manual: Updated Wic example
I updated the first example in the section telling how to build out
a Wic image.  I could not get the example to run so I used Stephano's
output.

(From yocto-docs rev: 6b4595215d6c24e3efb89288a7547f79ca3e59b7)

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
affb65b9eb dev-manual: Fixed broken link
(From yocto-docs rev: 4abc25e1b0b93bb232291e0bb51ec89c5e1f66f9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:15 +01:00
Scott Rifenbark
4694436ff8 dev-manual: Fixed broken link to WORKDIR variable.
(From yocto-docs rev: c239bd40e92cedee6301c176ff96821ea270fc39)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:15 +01:00
Scott Rifenbark
648a39c514 dev-manual: Replaced SERIAL_CONSOLE with SERIAL_CONSOLES
The former is deprecated.

(From yocto-docs rev: 1a1f89d91ceeb35f8cb5c2f9fc42fdb089ffc05c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:15 +01:00
Scott Rifenbark
67d4af220d dev-manual: Fixed broken link to Carna Botnet's article.
(From yocto-docs rev: 1d5e9bfea217051a457c30dcbd890366e9dd7611)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:15 +01:00
Scott Rifenbark
f79d1b9b5a dev-manual: Fixed target for a link.
(From yocto-docs rev: 59697f22f79d07b800d4f3ce2eb2ea41c987802b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:15 +01:00
Scott Rifenbark
6821aebbf0 dev-manual: Removed non-functioning link to EXTERNAL_TOOLCHAIN
(From yocto-docs rev: b0bd0c4d8070adf1439140230700b0de18f884ae)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:15 +01:00
Scott Rifenbark
738a83bddb dev-manual: Replaced "BSD" with "BSP" typo. Also small word change.
(From yocto-docs rev: d67856c849c5275a07ee1f87db839cd4d4d9a6f6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:15 +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
36bfaefddb dev-manual: Removed redundant link.
(From yocto-docs rev: bf64aad87e0248362e9cf9b693cd806ca32873fa)

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
031b508501 dev-manual: Fixed formatting issue.
(From yocto-docs rev: 4cd711d1305f480068447bac8881212a5b999d34)

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
2b4c765701 dev-manual: Slight wording change and link to a list of items.
(From yocto-docs rev: 26dd48f6995a1ac8da5ceba124d7795ebe857d53)

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
6ba0847558 dev-manual: Fixed a broken Gitolite link.
(From yocto-docs rev: 5d900f38079701a2ed8243071bd669bca1d97e1e)

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
183c4ab5c7 dev-manual: Fixed link to Toaster User Manual.
Had "Toaster Manual" in the cross-reference so it was not resolving
correctly when processed by mega-manual.sed.

(From yocto-docs rev: c99ce4a706df55e97388b45620ed2a503cb8312d)

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
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
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
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
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
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
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
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
f2242e613c documentation: Purged the YP Quick Start references from YP set
The original Yocto Project Quick Start is being retired for the
YP 2.5 release (sumo).  I have purged all the various references
from the YP manual set and replaced them with references to the
appropriate doc.  The references were mainly into the YP
dev-manual for setting up the host or for building an image.
There were a few references into the new "Yocto Project Quick
Build" document for overviewing manual-type references.

(From yocto-docs rev: 11c0ab693962f16f87f1e21f33dd5c6ca6a6f895)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:07 +01:00
Scott Rifenbark
21c0019f44 dev-manual: Added new section on conserving disk space
For conserving disk space during builds, I added a new section
that tells how to add "rm_work" to your local.conf file.
This information was part of the original YP Quick Start
and was not carried forward into the new brief build
document.

(From yocto-docs rev: 719d70587d908390a134559472d57ce7fced6aae)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:07 +01:00
Scott Rifenbark
7907cb7b6c Documentation: Updated Manual Notes
I did some re-wording to account for when the user does a web
search for a manual and the search returns an ancient version
of the manual.  Many times the user is oblivious of this fact
and is trying to use a version of the docs that don't come close
to matching the version of the YP.

(From yocto-docs rev: 1cbe06cefda2b35584a8365564e01888d229d0b3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:05 +01:00
Scott Rifenbark
b98b5b25f9 dev-manual: Added an id tag for the create layer step.
(From yocto-docs rev: 59b8c053f8fe94cc51ece86733c435ac7085eb57)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:04 +01:00
Scott Rifenbark
6103268a4f dev-manual: Updated the "Create Your Own Layer" section
Updated the explanation of the layer.conf file.  I am going
to use this section as the definitive section that explains
the layer.conf file.

(From yocto-docs rev: 4c70c7467f0ca5cf2346ef8d10bde437b971d2d2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:03 +01:00
Scott Rifenbark
d6a396b594 dev-manual: Updated the "Creating Your Own Layer" section.
Added information to the list of variables used in the
layer.conf file to specify LAYERSERIES_COMPAT.

(From yocto-docs rev: c41ff41e75b654d5d7df8c2a1e83ba5525490285)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:03 +01:00
Scott Rifenbark
feeb4592b7 dev-manual: Updated the "Creating Your Own Layer" section.
For step 3 on creating the layer, I put in wording to make sure
the user does not create a layer in the cloned poky directory.

(From yocto-docs rev: 1a0d1d0c0cdfa77c6df005d0294d11a02ca3770c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:03 +01:00
Scott Rifenbark
b77905f131 dev-manual: Updated layer creation example to use $HOME directory
Best practices dictate that the use not create a layer in the
poky repo.  So, I updated the example to move the user to a
top-level directory first and then create the layer.

(From yocto-docs rev: 81ab8b0f393f90785880aec7685c4c431cb7ad87)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:03 +01:00
Scott Rifenbark
b3732ab1aa dev-manual: Cleaned up layer naming terminology
Reality dictates that the YP does not treat layer naming consistently.
Layers are talked about as the "meta-whatever" layer and never the
"whatever" layer.  However, the tooling sometimes appends or uses
just the "whatever" part of the layer name.  A good example is the
meta-yocto-bsp configuration file.  All the variables in there use
just the root name of a layer's name.  In the manuals, I had been
distinguishing the layer name as just the "whatever" part sans
"meta-".  I talked about the convention of using "meta-" in front
of layer names, etc.  Well, this is confusing in light of how everyone
says a layer's name is "meta-whatever".  So, I fixed all this up.

(From yocto-docs rev: 79e52f6ccf4246fc69a460ce9d3a4a18720a9442)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-25 09:41:13 +01:00
Scott Rifenbark
fcbe72179c documentation: Updated the section on creating a general script
Split this section into two sections: one for creating the layer
using bitbake-layers create-layer and one for adding the layer
to bblayers.conf using bitbake-layers add-layer.

Needed to update some references in the yocto-project-qs and
kernel-dev manuals.

(From yocto-docs rev: 741a29b0cbeaaeaa0ac9155036ace2623938aee3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-25 09:41:13 +01:00
Scott Rifenbark
955e49c134 dev-manual: Created tip for using server outside of build area
Fixes [YOCTO #12419]

In the section on runtime package management, I created a "Tip"
box to tell the user about using a location for the package
index information outside of the "deploy" area of the hosts
build directory.

(From yocto-docs rev: 2aee814d3d3ed4052fca332693d5416907ae640e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-25 09:41:12 +01:00
Scott Rifenbark
4fda1ea353 dev-manual: Updates to the section on creating a layer
Provided some key links to help clarify content.

(From yocto-docs rev: 8d27b9946dad89729d30497bcc4de26b9a5c87d9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-25 09:41:12 +01:00
Scott Rifenbark
c0c1befbe9 dev-manual: Sanity edit through the layer creation section
(From yocto-docs rev: 91cda82ca148c56c18f059eeaa656d3561aed26d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-25 09:41:12 +01:00
Scott Rifenbark
e5702bce4a dev-manual: Completed rewrite of runtime package management
Fixes [YOCTO #12419]

This section was unclear and needed some work.  I added text to
help clear things up.

(From yocto-docs rev: 54358a39a5710dbd0cbcfe8dafd2f641ec3863ef)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-25 09:41:12 +01:00
Scott Rifenbark
54737f81cc dev-manual: Updated example output for creating layer
The example that creates a layer using bitbake-layers had old
output.  Updated it.

(From yocto-docs rev: c58d738a59f113f8fffe0fc40b22e06b9d96cb6f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-25 09:41:11 +01:00
Scott Rifenbark
4ae67cc01a dev-manual: Review edits to manual upgrades for recipes.
(From yocto-docs rev: 05307788395cb16af95e89592bda070be6c1a397)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-25 09:41:11 +01:00
Scott Rifenbark
6cb930c0ea dev-manual: Added section on manually upgrading recipes
(From yocto-docs rev: b5515ad6f4b5653095e338114607dd11a11181df)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-25 09:41:11 +01:00
Scott Rifenbark
1fccc4d2ee getting-started, dev-manual: Updated verbiage around new YP website.
(From yocto-docs rev: 033c7771ff1dfabf9f6ef9b6cb88a18f471e0c76)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-25 09:41:11 +01:00
Scott Rifenbark
47e92cd753 dev-manual: Added section on upgrading recipes.
Section covers AUH, devtool and manual.  Still need to add
manual.

(From yocto-docs rev: 56f04b1fcc8673e20df6d8f5c65120b03cad31e7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-25 09:41:11 +01:00
Scott Rifenbark
2d19694b58 dev-manual: Changed heading for mirror and pre-fectch section
The old heading was dangerously close to a heading in the
previous chapter.  I altered this heading to target more
specifically the content.

(From yocto-docs rev: 797bef2256308531f02e35dc0ef8b1d9cbaff935)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-03 08:35:26 +00:00
Scott Rifenbark
19916cfdab dev-manual: Added MACHINE conf qualifier to virtual provider
Needed to call out that using the include file is actually
using a MACHINE configuration file in this case.

(From yocto-docs rev: b33838d4711e0c55c6cf78e7491ce97bc9fd519f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-03 08:35:26 +00:00
Kristi Rifenbark
cdf4f79a5d dev-manual: Fixed checkout by tag example
(From yocto-docs rev: 70cf6e2eb2f9999f1d1b24c3897106e7e8f3e93f)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-03 08:35:25 +00:00
Scott Rifenbark
c6f2b40f1d concepts-manual, dev-manual: Moved the virtual providers to dev-manual
This topic was deemed unfit for concepts so I moved it to the
dev-manual and rewrote it to be "Using Virtual Providers".

(From yocto-docs rev: df7d48ac4fcf7ece75681ccf0bbb5699f7ff5ea6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-03 08:35:25 +00:00
Scott Rifenbark
35549a7a45 dev-manual, concepts-manual: Moved x32 section
I had split up the section on x32 into a concept piece and a "how-to"
piece earlier in order to satisfy outside pressure to isolate all
"how-to" stuff in the dev-manual.  Doing this put a "conceptual" blurb
about x32 in the new concepts-manual.  It has been decided that x32
is not a concept.  It really does not fit into the ref-manual either.
So, I have re-combined the intro blurb of the x32 stuff back as the
beginning piece of the "Usingt x32 psABI" section in the dev-manual.

(From yocto-docs rev: 6e8240cc1a90a8d78ff456d3138c525eceea3ee3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-03 08:35:25 +00:00
Scott Rifenbark
505a31c1a1 dev-manual: Updated Bmaptool section.
Provided a better flow and a bit more explanation of what Bmaptool
provides.

(From yocto-docs rev: 9a02cd7281038031fc4cdea98f114b9c318947a7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-03 08:35:25 +00:00
Scott Rifenbark
01658a83d7 dev-manual: Updated oe-run-native and dd examples for Wic
I changed the path to not list "build/" as the example assumes
the user is already in that directory.

(From yocto-docs rev: c3ab6a9e53f48005de73977238c8af3e2061db8b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-03 08:35:25 +00:00
Scott Rifenbark
e21faa4a9c dev-manual: Updated Wic example using existing kickstart file.
(From yocto-docs rev: a1f25bd6aae35e4c052e348949bea332b9203c20)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-03 08:35:24 +00:00
Kristi Rifenbark
a70b32c5a0 ref-manual, dev-manual: Removed fetchall and checkuriall tasks
Fixed [YOCTO #12547]

ref-manual:
Removed fetchall and checkuriall tasks.

dev-manual:
Replaced "bitbake -c fetchall target" command with
'bitbake -c target --runall="fetch"'.

(From yocto-docs rev: 6d5cad8755e8817d50a9f88cb18115f43bb0b54a)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-03 08:35:24 +00:00
Kristi Rifenbark
1a78cdaea6 dev-manual: Fixed variable link to DEFAULTTUNE variable
Fixed [YOCTO #12458]

(From yocto-docs rev: 161d7ec7c81db93120af11b07162b36785614302)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:32 +00:00
Scott Rifenbark
cfdf4c78eb getting-started, dev-manual: Created Layer Model section
This involved removing the general information about layers from
the dev-manual and incorporating it into the new section of the
getting-started manual.

(From yocto-docs rev: 26438b03751948661f48fb0c023e393101b80e19)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:32 +00:00
Scott Rifenbark
813772451f documentation: Moved the detailed build section to concepts-manual.
The section that provides a closer look into the build system has
moved from the getting-started manaul to the concepts-manual.
I fixed all the links, provided some coded formatting of the
entire section, and made general updates.

The other manuals had links that needed fixed due to the move.

(From yocto-docs rev: b83a5619f56ebd9879fdcadcf474859e68b26d58)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:31 +00:00
Scott Rifenbark
8d320536dc dev-manual, getting-started: Moved the BB syntax section
This section on BitBake syntax appeared in the Getting Started
manual.  I decided that it should live with the section on
writing a new recipe.

(From yocto-docs rev: 8d83ce3e11405b2f12f27cdd117a19c4af52146a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:31 +00:00
Scott Rifenbark
6512622882 documentation: Updated links into new concepts-manual
Creation of a new concepts manual and moving of chapters from the
getting-started (overview-manual) caused many links and manual
reference titles to break.  I fixed these throughout the YP
docs.

(From yocto-docs rev: 30f2bc46be4a0faf5302eb8605bcb29f3bee6cf3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:31 +00:00
Scott Rifenbark
4d623003f3 documentation: Purged overview manual references
When I converted the Yocto Project Overview Manual to the Getting
Started With Yocto Project Manual, I updated the strings for
references from "&YOCTO_DOCS_OVERVIEW_URL" TO
"&YOCTO_DOCS_GS_URL".  Unfortunately, I did it with a global command
that did not take into account the text the might follow the link
by saying "see such-and-such section in the Yocto Project Overview
Manual."  So, I had to hand fix these.

Additionally, since I have moved a deeper concepts chapter that
was in the getting-started manual to a new Yocto Project Concepts
chapter, many of those links changed had to really go to the new
manual instead.  Those were fixed.

(From yocto-docs rev: fca1c56b0764802fb6a687ea81ab0fb95186cf0a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:30 +00:00
Kristi Rifenbark
12a68f02bc dev-manual, ref-manual: Updated references to Bugzilla wiki page
Fixes [YOCTO #12475]

(From yocto-docs rev: 460660fda7433959cff13897ece4a6c9f7ff8d09)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:30 +00: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
ebc7de0948 ref-manual, dev-manual: Moved "Speeding Build" to dev-manual
Fixes [YOCTO #12370]

The section on "Speeding Up a Build" that was in the ref-manual
needed to be in the dev-manual as it is a "how-to" section.
Moved it.

(From yocto-docs rev: 44d2889a4f3fb5dfabb1ea4df68a1b8bbf9347c8)

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
30b91e6d89 documentation: Removed "usingpoky" chapter from ref-manual
Fixes [YOCTO #12370]

All of the information from the "usingpoky" chapter in the
ref-manual has been distributed out over the rest of the
YP manual set.  Primarily, this information went into the
dev-manual and the overview-manual.  Because the chapter is
no more, I had to update the mega-manual.xml to not include that
chapter. Also, had to update ref-manual to exclude the chapter
as part of the Make process.

(From yocto-docs rev: b988cab06d42f0ac2220cefe66949c5ab6cbf803)

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
355103f8cf dev-manual, ref-manual: Moved build history info to dev-manual
Fixes [YOCTO #12370]

The section in the ref-manual on build history has been moved to
the dev-manual.  It is more of a "how-to" piece of information than
a reference.

(From yocto-docs rev: 9634bd8dc51e2972e6a5f3a3d3b4256c8ca8749c)

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
c6f8814461 ref-manual, dev-manual: Moved QEMU info from ref-manual to dev-manual
Fixes [YOCTO #12370]

The QEMU information in the ref-manual "using" chapter has been moved
to the dev-manual's chapter 5, which is a dedicated QEMU chapter.
Some information is reference and that is why I had it separated out
into the reference manual.  However, pressures are mounting to get
that stuff out of the ref-manual and into the dev-manual.  So, it
has been moved.

(From yocto-docs rev: 69098ad83b10fab341ec3d5532e377dcfbbfc05e)

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
09e9f81c34 dev-manual: Removed "Build Notes" that had gone stale.
(From yocto-docs rev: 38e51c441619bf6b9761faeef8278b51997f93d3)

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
32651058c0 dev-manual, ref-manual: Moved building image to dev-manual
Fixes [YOCTO #12370]

The section in the ref-manual that overviewed the buld process was
redundant and more of a "how-to" topic.  I have moved and merged it
into the dev-manual into a similar area.

(From yocto-docs rev: 44f1351334342629aaa0976f62e64ac4f67166aa)

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
b1f5509fc8 dev-manual: Removed errant "-->" string
(From yocto-docs rev: b0102a47278bc6c0f598be889d0bfb78bc5f322d)

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
Scott Rifenbark
98a0739e59 overview-manual, ref-manual: Moved "Licenses" to overview-manual
Fixes [YOCTO #12370]

The "Licenses" section in the technical details chapter of the
ref-manual was concepts and needed moved to the new overview-manual.
Some links were broke during the move and they were fixed in the
BSP and dev-manual.

(From yocto-docs rev: 34c013f055736dcde2fe12daea1aaf2beaee97c5)

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
Scott Rifenbark
a60d9e2917 overview-manual, ref-manual: Moved auto added runtime deps section
Fixes [YOCTO #12370]

The "Automatically Added Runtime Dependencies" section moved from the
ref-manual to the overview-manual.  This topic is concepts and needs
to live in the new overview-manual's concepts chapter.  Fixed some
links in the ref-manual and one in the dev-manual.

(From yocto-docs rev: fa3e12030ce867cb81feed453d35c3a3643decd2)

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
Scott Rifenbark
00f87f8416 overview-manual, ref-manual: Moved "Shared State Cache" to overview manual
Fixes [YOCTO #12370]

The section on shared state cache needed to be in the overview manual
and not in the ref-manual.  I moved it.  Some links were affected,
which I fixed.

(From yocto-docs rev: 1c4e5207bdde19d4b48ef42b1de81390d8a02d64)

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
Scott Rifenbark
8097a978ce dev-manual, ref-manual: Moved Wic Plug-In section to dev-manual
Fixes [YOCTO #12370]

I had a section on Wick Plug-Ins in the ref-manual in the
"technical details" chapter.  This section has been combined with the
section on using Wic that lives in the dev-manual.  This move creates
a single section on using Wic to create Wic-partitioned images.

The section was moved out of the ref-manual and merged into the
dev-manual Wic section.

(From yocto-docs rev: 8724049141c9a793312dcf5ff5c3425948d1cbd0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:27 +00:00
Scott Rifenbark
e2060287db overview-manual, ref-manual, dev-manual: Moved x32 stuff
Fixes [YOCTO #12370]

The section on the x32 psABI topic was in the "technical details"
section of the reference manual.  This section combined conceptual
and "how to" information for x32 psABI.  I moved the conceptual
information to a new chapter in the overview-manual.  I moved the
"how-to" information to a separate topic in the dev-manual.  This
resulted in the mega-manual being updated to take on a new chapter
for the overview-manual (overview-concepts.xml).  No links were
affected.

(From yocto-docs rev: 84da28a4ad0f3f89bfc865f410a5d06b57439beb)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:27 +00:00
Scott Rifenbark
b797db0db4 documentation: Created new YP Overview Manual
Fixes [YOCTO #12370]

Added a new chapter to the newly created Yocto Project Overview
Manual.  This chapter originated from the YP Reference Manual and
was the old chapter 3, which talked a lot about various concepts.
This information is better suited for the new overview manual.

The change involved moving the entire chapter and renaming it.
This move of the content affected many, many external references
and links into the old area.  Consequently, I had to recast all
these links from the different manual.

Changes also included fixing the mega-manual.xml file so that it
would include the new overview manual as part of it.

Many figures had to be relocated as part of the move as well.  This
meant deleting them from the ref-manual/figures folder and putting
them into the overview-manual/figures folder.

(From yocto-docs rev: 87b81358f2bbd02b4a0d966d86c4d7b006d4d78f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:27 +00:00
Scott Rifenbark
9f478d1358 dev-manual, ref-manual: Moved source file sections
The sections in the introductory chapter of the ref-manual are better
served as part of the dev-manual.  These sections are about accessing
YP source files using various methods (i.e. source repositories,
index of releases, and nightly builds).  I have integrated that
information into the dev-manual where the information was also being
treated.

(From yocto-docs rev: d3a97b1f9367d5bb5370974c8c5c0404df86724a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:27 +00:00
Scott Rifenbark
8ee50cf71d dev-manual: Updated "Using RPM" section
Fixes [YOCTO #12419]

Updated the example to use http://my.server as the base.

(From yocto-docs rev: c61769ce2cd7fafbd5f1b349ecf9ac75dbae1a6f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-22 22:23:06 +00:00
Scott Rifenbark
bac81646a9 dev-manual, yocto-project-qs: Fixed some broken links
Links to the section in the BSP manual for how to create a new
BSP layer using 'bitbake-layers' were needing fixed.

(From yocto-docs rev: 150612925421b09e84f85514e65e58d179e5be46)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-09 14:29:08 +00:00
Scott Rifenbark
4db3915372 dev-manual: Updated bitbake-layers overview section.
The section was missing three of the summaries for the command when
you used --help to find out about it.  I added these in to the section.

(From yocto-docs rev: ac9c58322b7f8533335a9d4379aa031bb1de7be6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-11-12 06:51:20 +00:00
Scott Rifenbark
1b55ec668e dev-manual: Removed note about yocto-layer being deprecated.
Deprecation of yocto-layer occurred in 2.4.  For 2.5, we do not
need to mention this fact in the note.

(From yocto-docs rev: 619b74422baf3b531e2fc3db50a95019178a1c09)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-11-12 06:51:20 +00:00
Scott Rifenbark
24503ed3f5 documentation: Set up for "sumo" (YP 2.5) Release.
poky.ent - updated variables
<manual>.xml - updated manual revision tables
mega-manual.sed - replaced "2.4" with "2.5" for links.

(From yocto-docs rev: 15d1f805ad11fba145155dcec17b7ec8a21ad487)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-11-12 06:51:20 +00:00
Scott Rifenbark
f29cdba71a dev-manual, kernel-dev: Replaced yocto-layers with bitbake-layers command
The yocto-layers script is being deprecated in the 2.4 YP release
and the preferred script is now bitbake-layers.  In particular, the
section that talks about creating a general layer was using
yocto-layers create.  I have replaced it with bitbake-layers
create-layer command.

The bsp-guide and kernel-dev manual had links that used (in the
case of kernel-dev) and referenced yocto-layers.  I had to change
these to reflect using bitbake-layers create-layers.

(From yocto-docs rev: 73ec4d0c8c2c093b7c9df86038d132f0da975273)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:08 +00:00
Scott Rifenbark
8f03c32040 documentation: Updated title page notes and author group
Made the title page notes consistent across the manual set.

Made the author group information consistent as well.  It is better
that authorship is seen as a third party and not tied to Intel
Corporation.

(From yocto-docs rev: 32cec087e384e1d92e3e84bbae5c6560a0af3136)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:08 +00:00
Scott Rifenbark
9737e192f5 dev-manual: Updated links to SDK manual.
SDK manual title changes so the links into that manual needed updating.

(From yocto-docs rev: e59d1cb22d46b00e9413deb5c7a70a14be880dc1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:07 +00:00
Scott Rifenbark
34befd259d sdk-manual: Split the Eclipse section into a separate chapter
This also affected a link in the dev-manual and some setup stuff
in the mega-manual and sdk-manual.xml file due to a new chapter
being introduced.

This section on the Eclipse stuff is big enough to warrant its
own chapter.  I decided to pull it into a separate chapter of its
own.

(From yocto-docs rev: a4b2b605902f09bb200facfabb0a7c355fbf4c87)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:07 +00:00
Scott Rifenbark
458d0e720e dev-manual: Updated run QEMU basic syntax step
In Step 4 of the "Running QEMU" section, the file suffix
"*.vmdk" is mentioned.  "vmdk" has essentially become "wic.vmdk"
now.  I updated the example.

(From yocto-docs rev: 5e17ccabfe8eb9d3b4316ceb41df17eddc7b0065)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:07 +00:00
Scott Rifenbark
5ba6253ad2 dev-manual: Changed location of maintainers.inc file to meta/conf
(From yocto-docs rev: 0991f94a32c067375b6d58eb058f3bb3393f8a21)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:07 +00:00
Scott Rifenbark
a39d8d9988 dev-manual: Removed a couple instances of "meta-yocto"
(From yocto-docs rev: 7c23ff287cd5b2e550ab53514a6cc574b276d939)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:07 +00:00
Scott Rifenbark
a4f6e19e37 dev-manual: Updated title .PNG file
The manual title has changed to "Yocto Project Development Tasks
Manual".

(From yocto-docs rev: aa6b7959df1725257ee598f828d3e99e595308e5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:06 +00:00
Scott Rifenbark
f303209595 documentation: Updates to change dev-manual title
Updated several files to change the title of the dev-manual from
the "Yocto Project Development Manual" to the "Yocto Project
Development Tasks Manual."  Did some edits in the README and the
Makefile as well for completeness.

(From yocto-docs rev: 0278d6d3bb458af1cb04fbc3eed96dff12d19475)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:06 +00:00
Scott Rifenbark
908e338110 dev-manual: Fixed bad link
Link to metadata term was not going to the ref-manual.

(From yocto-docs rev: 7a116ece403cb88977dfcce3006e2e1bb52b5df0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:53 +01:00
Scott Rifenbark
72c820f08b documentation: Updates to cull out buried YP Website references.
With the redoing of the YP website, it was decided that the manuals
could only reference into the top-level and the top-level/documentation
URLs of the website.  I removed all references to areas such as
projects (e.g. Toaster, VM, etc.) and any other URL that was not
the top-level landing page or the documentation page.

(From yocto-docs rev: 2bd838f1a9fb2698bab098b13b76c8852853e0e7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:53 +01:00
Scott Rifenbark
962edb8d3d dev-manual: Updated .mtoolsrc error instruction note.
(From yocto-docs rev: cb8b2e89406a8c786bbabf78f17d66bb953c6dbf)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
Scott Rifenbark
07ec3f2f86 dev-manual: Added wic ls, rm, and cp example
Fixes [YOCTO #12191]

Put in a new example in the Wic section to highlight the use of the
'wic ls', 'wic rm', and 'wic cp' commands.

(From yocto-docs rev: 2bf316961d22d5dc2df2d849c50ec347d5f9db51)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
Scott Rifenbark
4320b808c2 ref-manual, dev-manual: Updated "Creating Partitioned Images" section title.
Added "Using Wic" to the section head because that is all we
talk about.  This affect three links in the ref-manual so I
fixed those as well.

(From yocto-docs rev: 0e4f245f2b872810e2e164a227900ca6aa313ab8)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
Scott Rifenbark
cbe8009a17 dev-manual, ref-manual: Moved kickstart reference to ref-manual
This section was misplaced in the dev-manual and really needed to
be in the ref-manual.  I created a new chapter that follows the
devtool reference chapter and put the kickstart chapter there.

Links were needed to be fixed up and a new chapter in the
ref-manual named ref-kickstart.xml had to be created.

(From yocto-docs rev: b4d5b7077a978e4966d1273a374741075a1b0c7d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
Scott Rifenbark
6077ebbe80 ref-manual, dev-manual: Moved plug-in section for wic to ref-manual
Fixed links affected by the move.

(From yocto-docs rev: 250d312274788b0eebf3ae9143f2f89eafd4ab90)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
Scott Rifenbark
7cf82df8b0 dev-manual: Updated the plug-ins section.
(From yocto-docs rev: d1a4ff5ee177c7b9442d805b6e20a8ba8410d91d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:51 +01:00
Scott Rifenbark
e746cc1c65 dev-manual: Updated Wic Kicstart examples.
(From yocto-docs rev: b5393e416c779aa9d4f5116cdea8d5fd09c21bd1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:51 +01:00
Scott Rifenbark
b402b283c8 dev-manual: Fixed broken link to "Images" section in ref manual.
(From yocto-docs rev: b5bc0f8d4be9746281d81555d7c90f66be285fe0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:51 +01:00
Scott Rifenbark
e99b83f4b0 Documenation: Updated "Usually October" to "October 2017" string
The string in the manual revision table needed updated across the
set except for the kernel-dev manual.

(From yocto-docs rev: e087a707e02ff913baba2ac8bc6594206f53f70c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:34 +01:00
Scott Rifenbark
fae276ea09 kernel-dev: Eliminated "Generating Configuration Files" section.
This section was largely redundant now.  The small things that did
add value I placed in other areas of the chapter 2.  One was a new
section on expanding variables using bitbake -e.  Another was a bit
about the defconfig file.  And a small procedure on how to create
config fragments using the "diffconfig" command was retained.

Links from the dev-manual and the ref-manual were adjusted as well.

(From yocto-docs rev: 7059d3eac1fec20089cabf197503f1bec747686d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:33 +01:00
Scott Rifenbark
0e7af54763 dev-manual: Updated compatible log program section.
Script name changed to "yocto-check-layer".

(From yocto-docs rev: 545a90dd2816c4e97dc70efc76c7cca49684c2d8)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-26 11:18:59 +01:00
Scott Rifenbark
de671802c8 dev-manual: Compatibility program and moving kernel configuration
Should have been two commits but I forgot to do them separately.

1. I updated the YP Compatible Program section.

2. I moved the "Configuring the Kernel" section from the dev-manual
   to the kernel-dev manual.

(From yocto-docs rev: cdb5bbc917db55a2ca987ce9b9ed371f9fca6524)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-26 11:18:59 +01:00
Scott Rifenbark
f94f6e655f dev-manual, ref-manual: Image format implementation changes
Recently a number of changes have happened on the implementation
side of some image formats, and a few have been renamed.
The u-boot image signing code is now always available and no
longer in a stand-alone file.  The vmdk/mdi/qcow2 images have
been removed and are now just a conversion type that is applied
to wic images.

Reported-by: Tom Rini <trini@konsulko.com>
(From yocto-docs rev: ce86da3d48507cee12208e0138c285b4be83d8cd)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-22 17:53:44 +01:00
Scott Rifenbark
b673c3b990 dev-manual: Replaced release names and numbers with variables
In several examples, hardcoded versions of release names and
versions were being used.  I updated to use variables from
poky.ent so that examples would use most recent release.

(From yocto-docs rev: 53f8e92075cc34538f36d7fba392ea1ac9a6dd1f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-22 17:53:44 +01:00
Scott Rifenbark
b103ff6ba7 documentation: Purged "oe-init-build-env-memres" from docs
Fixes [YOCTO #11968]

Purged all occurrences of the "oe-init-build-env-memres" script
from the YP documentation set.  Occurrences in a lot of places.
The BBSERVER variable was also impacted and had to have the
definition updated.

(From yocto-docs rev: 274b05108d1bc53df20c11ab2efa15363bce23da)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-22 17:53:44 +01:00
Scott Rifenbark
26975ed662 dev-manual: Added links to branch and tag checkout from overview.
(From yocto-docs rev: 122948411e1121be862caa43d216126c3a01f1fc)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-13 18:00:19 +01:00
Scott Rifenbark
db3c4c8557 dev-manual: Updated the reader pointers after poky clone
Added in a sentence to point to the kernel-dev manual should
the user be interested in kernel development.

(From yocto-docs rev: cc47606af5b7eb2fdc669aa2c0c4dfbd930b8247)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-13 18:00:19 +01:00
Scott Rifenbark
ea256df2a8 dev-manual, kernel-dev: Working kernel flow process using devtool
A work-in-progress of an example that modifies the kernel
using the devtool.  The procedure is not complete yet as it
does not run properly.

(From yocto-docs rev: 462ba2e46f237c294f05805ad5044291a085975d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:49 +01:00
Kristi Rifenbark
f76e038674 dev-manual: Added support for signed RPM package feeds
Fixed [YOCTO #11209]

Rewrote so text indicates signed RPM package feeds work.

(From yocto-docs rev: 41c1e3d786f4436de59697431b2494cbabdebb8d)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:49 +01:00
Scott Rifenbark
7254c5086b dev-manual: removed note indicating signed RPM packages unsupported.
(From yocto-docs rev: 00c312e7515d82661fb16cd51f8fe9d03b4ea394)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:48 +01:00
Scott Rifenbark
a64831cad7 kernel-dev, dev-manual: Moved Kernel prep steps
The dev-manual had a place-holder section for getting the
build host ready for using YP and then doing kernel
development.  This stuff is better suited for the actual
kernel development manual.  I moved the section.  Moving
created several broken links in the manual set that had to
be fixed.

In the dev-manual, I updated the introductory list to include
the newly moved kernel stuff.

(From yocto-docs rev: 2e21260bb5f84e9e30eb353ec841d5962e8a7642)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:48 +01:00
Scott Rifenbark
a037f60768 dev-manual: Pulled Eclipse preparation section
I moved the section on preparing a build host to use the
Eclipse IDE and placed it as introductory text for the
section that talks about getting the system ready for either
native Linux or CROPS use to use YP.

I also created as part of that list, links to the BSP manual
where I now talk about getting the system ready for BSP
development.

(From yocto-docs rev: f5b5d27ea5036792a96c0a42a3d7513a2a57a4b0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:48 +01:00
Scott Rifenbark
2b93720cfc bsp-guide, dev-manual: Moved BSP Layer prep steps to bsp-guide
The YP Development Manual had some build host preparation steps
as part of the chapter that talks about getting a host ready
for using YP.  These steps are better suited in the BSP Guide.
I moved them there and filled out the steps to be more complete.

(From yocto-docs rev: 2277812d0dd411a103a4a4252d4cb90c471901c9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:48 +01:00
Scott Rifenbark
a99c2c5581 dev-manual, kernel-dev, sdk-manual: Moved patching kernel section
Moved the "Patching the Kernel" section, which was in the
dev-manual to the kernel-dev manual.  During the move,
renamed the section to "Using devtool to Patch the Kernel".

This move bothered a lot of links so I had to fix them in
various manuals.

(From yocto-docs rev: a000be1eddf33e4d7de8f350e076d48e27ca4b98)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:48 +01:00
Scott Rifenbark
c35f87a7ea dev-manual: Updated simple build flow, text and diagram
Now that we have CROPS as an option, the step for preparing
your build host is condenced to include cloning poky.  This
resulted in removal of step 2 and updating of the figure.

(From yocto-docs rev: 903d1f98b736a744de1d9c973f7a96b6a92049b5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:47 +01:00
Kristi Rifenbark
203a8393e4 dev-manual: Updated "Sharing Files Between Recipes"
Updated text for sysroot terminology, and clarity.
Fixed a capitalization error.

(From yocto-docs rev: 4eea6497663efc937cddf4700298f5824ade7b47)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:47 +01:00
Scott Rifenbark
d369f33383 dev-manual, ref-manual: Moved recipe syntax section to ref-manual
The section on recipe syntax that was buried in the creating a
new recipe section was really a reference on syntax.  I have moved
it to the ref-manual.

(From yocto-docs rev: cb55d1b5832cca6faa6e2a5b26f3add3032cade2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:47 +01:00
Scott Rifenbark
07514c9003 dev-manual: Converted sections for following best layer practices
The section about following best practices was more of a reference
section the way it was written.  I recast the section and the
sub-sections such that it is a list of items to consider.

Also renamed the section to be more of an action section rather
than passive.

(From yocto-docs rev: 8b050a46c67a3d3e89d905cf028eec6ae370388a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-08-09 09:25:24 +01:00
Scott Rifenbark
7d7eb04b9c dev-manual: Updates to "Using .bbappend Files in Your Layer"
I did some rewriting for clarity in the "Using .bbappend Files
in Your Layer" section.  The section needed to be retitled so
focus on the layer aspect of .bbappend files.  Also, while I
was in there, I did more work on the prose in general.

Also had to fix some links in the bsp, kernel, and ref manuals
that linked into the section whose name I changes.

(From yocto-docs rev: a82bcc9fe0f909135434ee1bd36b4414f6c046c9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-08-09 09:25:24 +01:00
Scott Rifenbark
2155745fff dev-manual: Changed wording that intros layer creation steps
I updated the wording to note that the steps are how to create
a layer without the aid of steps (i.e. by hand).

(From yocto-docs rev: 81800fa9ba0dd9ff439a43b286981eea51d4c87f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-08-09 09:25:24 +01:00
Scott Rifenbark
6d7b42f650 dev-manual: Added Links for specific container use
At the end of the section that describes how to set up the
development machine for CROPS, I added some user links for more
information based on the type of container the use is interested
in.

(From yocto-docs rev: 6888d8454839bbb2ecdf96ce421c7d8723931d65)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-27 23:00:23 +01:00
Scott Rifenbark
a2dfac68b5 dev-manua: Added Crops setup section.
(From yocto-docs rev: e2ba131b98705f98463030dde043d858b500690d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-27 23:00:23 +01:00
Scott Rifenbark
38ee8ae876 dev-manual: Added steps to set up native linux host
Fixes [YOCTO #11630]

Added content for steps to set up a native Linux host for using
the Yocto Project.

(From yocto-docs rev: d8a18d382c584dbdfa7f5f190a92cc7cde0f9601)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-27 23:00:23 +01:00
Scott Rifenbark
15901164ee dev-manual, ref-manual: Eliminated pre-built section
Fixes [YOCTO #11630]

I took the section that described how to use a pre-built kernel
and run it through QEMU out.  This is basically a QEMU usage
section and is not in that area.  There were some QEMU speed
up items suitable for the QEMU concepts section in the ref-manual.
I put those in that area.

(From yocto-docs rev: b081013aa10b42e4eb88ed54940112c5ae106911)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-22 09:19:25 +01:00
Scott Rifenbark
2217d97ba9 dev-manual, ref-manual: Re-wrote QEMU section.
Fixes [YOCTO #11630]

I converted the QEMU section to a procedure.  Also took the
tips section and created individual sections from that.

Cleaned up some areas in the QEMU conceptual section in the
ref-manual

(From yocto-docs rev: dfd3466be605fdd7438653bf54fd0df3594a5c50)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-22 09:19:25 +01:00
Scott Rifenbark
da066d8cdf dev-manual: Scrubbed machine type for runqemu command.
(From yocto-docs rev: 9d7042661ab106055e4c09e4bbb41a8592c715c4)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-22 09:19:25 +01:00
Kristi Rifenbark
088f55a535 dev-manual: Fixed Flash the Device example
Fixes [YOCTO #11774]

Updated bmaptool instructions in Flashing
Images Using bmaptool section by changing
the sudo command.

Fixed the oe-run-native line.

(From yocto-docs rev: c3a1e2882abbb7b682ce101a8b038f89c4e2261c)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:16 +01:00
Scott Rifenbark
f49fa46e19 dev-manual: Updated the section on initramfs
I did a rewrite of the section to get it into a procedural form.
Missing some technical information and needs a review but it is
the best that can be done at this time.  The code for initrd is
not settled.

(From yocto-docs rev: 0fdef8c5fed6ac510d1604a677e6546494b4c96b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:15 +01:00
Scott Rifenbark
e4f288d519 dev-manual: Updated "Performing a Simple Build" section.
I added a figure for this simple build workflow that uses
BitBake from a Linux host.  Also did a bit of re-writing.

A new figure was introduced so the Makefile had to be adjusted
to include that figure.  The figure resides in the figures
directory of both the dev-manual and the mega-manual.

(From yocto-docs rev: c3b0b1d53f551c02202cef80a8a48dd24576b975)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:15 +01:00
Scott Rifenbark
6031f8cfb1 dev-manual: Updated cover information to remove Intel
The author of the book was still Intel Corporation.  This
needs removed.  I replaced it with "Scotty's Documentation
Services, Inc.".

(From yocto-docs rev: 14f1df18210a3dcb4b7174ddcad551aa9141696d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:15 +01:00
Scott Rifenbark
293b53674c documentation: Moved devtool workflow to sdk manual
Fixes [YOCTO #11630]

The section on the devtool workflow in the dev-manual was 99%
identical to what was in the sdk-manual.  I have moved the
workflow procedure from the old "Model" chapter of the dev-manual
to be merged with what was in the sdk-manual.  In truth, the
only things added were a note about devtool not being exclusive
to SDK development.

The result of moving (deleting) this section was that the "model"
chapter of the dev-manual went away.  The devtool stuff, Quilt,
devshell, and python shell are all out now and there is no
chapter left.  So, mega-manual had to be adjusted to not pull that
chapter in when building the dev-manual.  I had to delete three
figures that were used in the flow.  The figures were already
replicated in the sdk-manual.  The figures were deleted from the
figures folder of both the dev-manual and the mega-manual.

I had to make sure all references to the old devtool stuf in the
YP doc set were adjusted.

(From yocto-docs rev: 5dbd643d31ab502df53a22229e457a03da7772b7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:15 +01:00
Scott Rifenbark
b15a65b8ea dev-manual: Moved devshell and python shell workflow sections.
Fixes [YOCTO #11630]

These two sections can stand alone as tasks.  I moved them to the
"Common Tasks" chapter.

(From yocto-docs rev: 60c810a9682f8a110fe7c7e4d0d40583a7d72735)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:15 +01:00
Scott Rifenbark
81add6e460 dev-manual: Moved "Using Quilt in Your Workflow" to tasks
Fixes [YOCTO #11630]

The section on useing Quilt can be a stand-alone task.  I moved
it to the "Common Tasks" chapter.

(From yocto-docs rev: bb84b88fc8fc7f82e7bbe580d408ae7880f38d8b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:15 +01:00
Scott Rifenbark
b171aea836 dev-manual: Moved "Finding Temporary Source Code"
Fixes [YOCTO #11630]

This section can stand as a separate task.  I have moved it to the
Common Tasks chapter.

(From yocto-docs rev: e4fb1ce8b160528aae0f192add614a595b2560a3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:15 +01:00
Scott Rifenbark
431ceaea6c kernel-dev, dev-manual: Moved Kernel workflow section to kernel-dev
Fixes [YOCTO #11630]

The overview section of modifying the kernel needed to be in the
kernel-dev manual and not in the dev-manual.  I moved it and took
care of all the links and external references throughout the YP
doc set.  One figure was involved that had to be moved to the figures
folder in kernel-dev from dev-manual.  That is why the Makefile had
to be edited.

(From yocto-docs rev: 3a704b64544678785b883f82d6e82aedac6790c5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:15 +01:00
Scott Rifenbark
b643938bde dev-manual, kernel-dev: Moved the kernel build hierarchy section
Fixes [YOCTO #11630]

The section that presented the Yocto Linux kernel file structure
resulting from a build using BitBake needed to be in the kernel-dev
manual.  I moved it over.  This required transferring over a
figure as well.

(From yocto-docs rev: 0abc6c7d87a6aa10dac28fefbb280eb51fea61a7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:15 +01:00
Scott Rifenbark
64f0f60b3f dev-manual, kernel-dev: Moved kernel branch concepts to kernel-dev
Fixes [YOCTO #11630]

The information in the dev-manual kernel overview area really neeeds
to be in the Appendix on kernel structure in the kernel-dev manual.
I moved that informtaion to the appendix.  Removal of one redundant
image was necessary from the dev-manual.  The figure was literally
repeated in the kernel manual already under a different file name.

(From yocto-docs rev: 00ca68e760e41448c225fb1ca4a77f5201434b93)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:14 +01:00
Scott Rifenbark
bdeb6db2fb kernel-dev, dev-manual: Moved Yocto Linux kernel overview
Fixes [YOCTO #11630]

I took the Yocto Linux kernel overview list of kernels out of the
dev-manual and moved them to the "Yocto Project Kernel Development
and Maintenance" section in Appendix A of the kernel-dev manual.
This is a much more logical area to introduce this type of Yocto
Linux kernel information.

(From yocto-docs rev: 0a5154cb4c23697f2b8e2341c8e1dc07362443d2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:14 +01:00
Scott Rifenbark
7d2d54683c dev-manual: Removed Toaster development flow
Fixes [YOCTO #11630]

Took the small reference section out for developing an image
using toaster.  This was just a pointer to the toaster manual.

(From yocto-docs rev: 8dcce4411aaa5d1d8fe2c809166a947d0e38a97b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:14 +01:00
Scott Rifenbark
fbdb36a568 dev-manual: Removed SDK workflow section
Fixes [YOCTO #11630]

This section simply pointed to the SDK manual.  Does not
need to be in the new "how-to" form of the dev-manual.

(From yocto-docs rev: 1cd842a323ba09ef69e14f56dca1c2a5576252ee)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:14 +01:00
Scott Rifenbark
b9430113c6 dev-manual: Clarifications for files in checkout out by tag
I put in some edits to be very clear on the state of the files
for the user when they check out by tag.

(From yocto-docs rev: 622d324e7f167f55a5de86ec7af65d7554f2aec8)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:14 +01:00
Scott Rifenbark
1b2d89737f dev-manual: Added branch clarification to checking out poky
Re-wordings to be clear about what the user is getting when
they check out a development branch of an upstream repository.

(From yocto-docs rev: deb6ecfd35a76760bc2270bbbc69aa232b0c8cc7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:14 +01:00
Scott Rifenbark
95547dab77 dev-manual: Wording updates "Cloning the poky Repository"
Clarified wording so reader understands they are checking
out the master branch by default.

(From yocto-docs rev: d1e77fff752d9960120340601bc2520c51c4f073)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:14 +01:00
Scott Rifenbark
f384aa0c70 dev-manual: Lead-ins for "Using the Downloads Page" procedure
Manual style dictates use of bold lead-ins for a numbered list.

(From yocto-docs rev: 32469dc0d61d755d0119a0374070221b0bd4bdfb)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:14 +01:00
Scott Rifenbark
057adefbf0 dev-manual: Bold lead-ins for "Accessing Index of Releases"
Manual list style requires steps to have bold lead-ins.

(From yocto-docs rev: 2d226cf6710853f7be8f0c3bd8b1eea72cb4eb7f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:14 +01:00
Scott Rifenbark
e3fd3ca235 dev-manual: Added bold lead-ins for "Accessing Source Repositories"
Formatting style need bold lead-ins for steps.

(From yocto-docs rev: b75337188e2346dd40004e22b45a2975f1d4cff3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:14 +01:00
Scott Rifenbark
a8c8680f84 dev-manual, bsp-guide: Moved BSP development workflow section
Fixes [YOCTO #11630]

Moved the section on BSP Development workflow from the dev-manual
into the bsp-guide.  This procedure needs to live in the BSP
guide.

Many links had to be fixed.

(From yocto-docs rev: fbf06240f83221929aea237660146e0076207f6a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:14 +01:00
Scott Rifenbark
d552379be3 dev-manual: Moved the "Flashing Images using bmaptool" section.
Fixes [YOCTO #11630]

Moved this section from the "Getting Started with the Yocto
Project" section.  The topic is not really a getting started
topic.  It is better suited in the "Common Tasks" chapter.

(From yocto-docs rev: d6cdade9066bdbce0596672978c178d2ec82c9a4)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:14 +01:00
Scott Rifenbark
15a41d25e9 dev-manual: Updated "Building Images" section
Fixes [YOCTO #11630]

I re-wrote the "Building Images" section into a "Performing
a Simple Build" section.  A single link in the common tasks
chapter was affected by the section name change.

(From yocto-docs rev: de5a4cfa4f63538fe0a5ec0c2aacfb9222b70c4b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:14 +01:00
Scott Rifenbark
b7356ec7f9 dev-manual: Fixed poor cross-reference
Was referencing the "Building Images" section when should have
been referencing the "Images" section in the ref-manual.

(From yocto-docs rev: 7340b358d57c110240e75c1164226144065120b7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:14 +01:00
Scott Rifenbark
ba6887404a documentation: Re-write of dev-manual setup chapter
Fixes [YOCTO #11630]

The chapter on setting up YP has been completely re-written to
move towards a "how-to" manual.  This involved touching every
aspect of the chapter.  All subsections now have procedures
surrounding set up stuff.  There are some development sections that
still need fleshed out.

Many, many links and references in other chapters were affected.
These have been fixed.

A couple style-sheet (*.css) files were also updated to support the
"writernotes" style, which renders paragraph text in red.

(From yocto-docs rev: c4c2a6cf575ce5c783b1cc84d9f7e961aebef49c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:13 +01:00
Scott Rifenbark
ed25d7df9c dev-manual, ref-manual: Added procedure for Downloads page
Fixes [YOCTO #11630]

Added a new procedure section for using the Downloads page from
the YP website.

(From yocto-docs rev: 7efb29dfa7a0960710ca7cf3983048f166c6a13f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:13 +01:00
Scott Rifenbark
576af718e6 dev-manual, ref-manual: Added section on index of releases procedure
Fixes [YOCTO #11630]

I have added a new procedure on using the Index of Releases area
to get snapshots of various tarballs.  I recommend that is not
the way you usually want to get files as using Git is recommended.
The section exists for completeness.

In the ref-manual, I cross-reference the procedures from the
associated conceptual areas.

(From yocto-docs rev: 812f344966966591d883fbebb4ae1f72c11dd483)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:13 +01:00
Scott Rifenbark
8ee16983cb dev-manual, ref-manual: New section on viewing GUI YP repositories
Fixes [YOCTO #11630]

I created a new procedure for locating and viewing YP source
repositories using the GUI-based method.  Created an anchor in the
ref-manual so I could reference the 'git clone' command.

(From yocto-docs rev: 2ae28682407039420f4fcca71a298e1dd34c81f0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:13 +01:00
Scott Rifenbark
d3a0e0abc1 dev-manual, ref-manual: Established section on YP source files
Fixes [YOCTO #11630]

To move toward a "how-to" dev-manual, I am consolidating procedures
for locating and establishing local copies of YP source files into
a single heading.  I set up a "Working With Yocto Project Source
Files" section.  This will contain sub-sections to find the various
areas of YP files and how to clone and check out stuff.

(From yocto-docs rev: 87ff4ee41a50e8aed6b9c5402c51bb47f5a252a3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:13 +01:00
Scott Rifenbark
0f00914578 documentation: Reorganized YP introduction material.
This material was being replicated across the Quick Start,
dev-manual, and ref-manual.  I have created a single point in the
ref-manual that collects the disparate information that existed.

I deleted the entire section in the dev-manual since that book
is converting to a procedure manual and the very front of the manual
adequately mentions YP and provides pointers to where the user can
get more information.

The QS provides a more complete introduction of YP since it is a
QS.

(From yocto-docs rev: bd8093417af2d93556410d5482dad32c11a0a964)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:13 +01:00
Kristi Rifenbark
d6c3c579d0 dev-manual: Updated Using RPM example
Fixes [YOCTO #11699]

Configuration example didn't work with "" around
baseurl. Removed "".

(From yocto-docs rev: c40d818fb92904b74e677749ee16c52716dd02a9)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-07-12 00:28:13 +01:00
Scott Rifenbark
1b36eebc23 dev-manual: Updates to the section on submitting changes to YP
I added detail to the procedure about pushing a change to a
contrib directory and then requesting a pull using the scripts.
More detailed with examples.

Also, clarified some wording in the section about submitting a
patch through email.

(From yocto-docs rev: 76a358ba588b0f36d14aef0a68efe30c4e16746a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:45 +01:00
Kristi Rifenbark
33b507e995 dev-manual: Updated checkout by branch
Example was incorrect. Fixed it.

(From yocto-docs rev: 7ae1c636e7a8c0448515f339476327bcaf21e63c)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:45 +01:00
Scott Rifenbark
cf2169b351 dev-manual, ref-manual: Re-wrote the intros
Fixes [YOCTO #11630]

I updated both the introductory sections of the ref-manual and the
dev-manual.  These need to work more tightly with the projected
YP documentation set.

(From yocto-docs rev: 6a28537d03fad8a53198edc7f9a6229f4e58e551)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:45 +01:00
Scott Rifenbark
1e90dd09ff dev-manual: Updated first section title to "Welcome"
I want this first section to be titled "Welcome" rahter than
"Introduction."  It is more in line with the YP QS and the YP
ref manual.

(From yocto-docs rev: 113b82c589c93a33a2a956790668e8c0a28894ec)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:44 +01:00
Scott Rifenbark
eed50a14fe documentation: Changes section head for sumbitting change to YP
Fixes [YOCTO #11630]

I changed the section heading for the section that describes how
to make a change to the YP.  It was passive.  I need it to be
active and in line with the "how-to" dev-manual.

(From yocto-docs rev: 340e1b6ab9806ec11ec894d4472bc2c937c2b058)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:44 +01:00
Scott Rifenbark
cd9279ab5c dev-manual: Updated the section on the YP development environment
Fixes [YOCTO #11630]

Extensively updated the development environment section by
creating a task-oriented section.

(From yocto-docs rev: d440f0b5ceb1aca57a73d8bced515ae0bd3188f7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:44 +01:00
Scott Rifenbark
e928b5251c dev-manual: Updated "How to submit a change" section.
Fixes [YOCTO #11630]

The section on how to submit a change was pretty much a procedure
section.  I did some rewriting to make it more that way.

(From yocto-docs rev: d7edce9268ee5cae96c09c79fe34d5d2dbb701e0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:44 +01:00
Scott Rifenbark
652d8cb583 dev-manual: Fixed a DocBook issue with formatting "bug-id"
I discovered a mis-placed block of DocBook text that was
causing the string "bug-id" to appear in a random spot in the
"Patch Submission Details" section.  Re-ording this block
fixed the problem.

(From yocto-docs rev: 6cf0e8ff0d2b176c1faf492c7bdd7d38e23e4c98)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:44 +01:00
Kristi Rifenbark
1e1bb0dd42 dev-manual: Updated syntax for oe-run-native script
OE native script now requires a native tool as part
of the command line. I added that to the example.

Removed a bad help command at the end of the section.

(From yocto-docs rev: 5eb965ea51d669ee3bac01050b42bee984572199)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:44 +01:00
Kristi Rifenbark
a331904ab2 dev-manual: Fixed two grammar errors
(From yocto-docs rev: 4e68646edf078c23e414a300b37cb30774b28be7)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:44 +01:00
Kristi Rifenbark
b2ad7c74d1 dev-manual: Updated "Kernel Overview" section
The list of supported kernels was out of date.
Edited with updated information.

(From yocto-docs rev: b287f76905637834ec6342285b99abd2c5594597)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:44 +01:00
Scott Rifenbark
98ba0cd476 dev-manual: Created "Working With Git Repositories" section
Fixes [YOCTO #11630]

This new section has three new procedures for now: 1)
cloning the poky repository, 2) checking out a branch
based on an upstream repository branch name, and 3)
checking out a branch based on an upstream tag name.

More to be added for other key repositories.

(From yocto-docs rev: 4cbcd952ba395b19be5374470a95630a4bc6ffa7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:44 +01:00
Scott Rifenbark
fcb53beee4 documentation: Moved "Git" section to the ref-manual
Fixes [YOCTO #11630]

The "Git" section in the dev-manual is really about concepts.
There are a couple of examples that might or not might be
allowed to ultimately stay.  I have moved the section to the
ref-manual.  If those examples get replicated in the new
dev-manual, I will update the "Git" section further.  For now,
however, these remain in this moved section.

(From yocto-docs rev: 2e4b87fdab29c13ce0d2314e50c93e37404b6f7e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:44 +01:00
Scott Rifenbark
c7969c64bb dev-manual, ref-manual: Moved "Workflows" section to ref-manual
Fixes [YOCTO #11630]

I moved the "Workflows" section to the ref-manual.  This section is
primarily concepts and needs to be out of the dev-manual, which
is being reconstituted into a "how-to" manual.

(From yocto-docs rev: 2f8bfaac3da9e2d7042ea381a3e8957f96b5bf5a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:43 +01:00
Scott Rifenbark
912d73d42b dev-manual, ref-manual: Moved "Licenses" section to ref-manual
Fixes [YOCTO #11630]

Moved the "Licenses" section from the dev-manual to the ref-manual.
The information in the section is purely reference material and
does not belong in the dev-manual, which is being reconstructed
as a "how-to" manual.

(From yocto-docs rev: a89cb18f6cab6702a2bf2a0f77d46e64f82b1729)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:43 +01:00
Scott Rifenbark
216ee69227 documentation: Moved "Yocto Project Source Repositories" section
Fixes [YOCTO #11630]

The "Yocto Project Source Repositories" section is purely conceptual
and thus does not belong in the reconstituted dev-manual, which is
converting to a "how-to" manual.  I have moved this section to the
ref-manual under "The Yocto Project Development Environment" section.

Moving the section affected several things.  Three figures that where
in the dev-manual were copied and moved to the figures folder of the
ref-manual.  This required deleting them from the dev-manual and
adding them to the ref-manual.

The makefile had to be edited to move those figures into the ref-manual
and delete them from the latest version of the dev-manual in order for
the tarball of files to be correct when the manuals are made.

Links to anchors within the moved section had to be fixed in various
manuals.  Links to the main section "id" had to be fixed to point
to the ref-manual manual.

(From yocto-docs rev: c619ae2bbc6be93cb0324ca44e936eefec12b28c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:43 +01:00
Scott Rifenbark
12cc5f7ab2 ref-manual, dev-manual: Moved "Open Source Philosophy" to ref-manual.
Fixes [YOCTO #11630]

The "Open Source Philosophy" section that was in the dev-manual is
really conceptual reference information and has no place in the
dev-manual, which is being re-written to be a "how-to" manual. I
moved the section into the new "ref-development-environment.xml"
chapter.

No links were affected by this.

(From yocto-docs rev: 0a3e65bf7a23eec6e36a3cda3c2011b70aef325b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:43 +01:00
Scott Rifenbark
de6d45fefc documentation: Re-org for "closer-look" chapter
Fixes [YOCTO #11630]

The ref-manual needs expansion for the old "closer-look" chapter.
This chapter previously held a detailed look at what happens when
a user uses the YP to develop something.  Now, the chapter needs
to also contain YP development environment concepts (e.g. open-
source philosophy, etc.), which are coming from the dev-manual.

Because of this, I renamed the "closer-look.xml" chapter to be
"ref-development-environment.xml".  I also renamed the larger
section that was formerly the entire chapter into its own section
named "Development Concepts".

Both these changes caused a few links to break.  I fixed all the
links from within the various manuals so they would find appropriate
targets.

I did some re-writing for introductory material to introduce the new
chapter and the section on "Development Concepts".

A new file ("ref-development-environment.xml") was added by basically
renaming the "closer-look.xml" chapter.  And, the tracking for
"closer-look.xml" was deleted.

(From yocto-docs rev: e37806474578b4f0ed137f64d68a39a17ab60644)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:43 +01:00
Scott Rifenbark
800ee0167a dev-manual: Fixed broken links to "Source Directory" term.
Fixes [YOCTO #11630]

Moving the "Yocto Project Terms" section from dev-manual to
ref-manual broke all the links to the "Source Directory" term.
I fixed them.

(From yocto-docs rev: d3a206b141e0b0c623362622ec73bbf44118071a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:43 +01:00
Scott Rifenbark
2ff49eaea0 dev-manual: Fixed broken links to "build-system-term" term
Fixes [YOCTO #11630]

Moving the "Yocto Project Terms" section from the dev-manual to
the ref-manual broke a single link to the "build-system-term"
id.  I fixed it.

(From yocto-docs rev: 51bbfbb6030a5298fde1dc0e6f67332cfa59fae2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:43 +01:00
Scott Rifenbark
f42d8f4cf0 documentation: Fixed links for "metadata" term.
Fixes [YOCTO #11630]

Moving the "Yocto Project Terms" section from the dev-manual
to the ref-manual broke the links to the "Metadata" term.
I fixed these.

(From yocto-docs rev: 190da4b4d44952d141db26ca72b5bc1a52d77023)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:43 +01:00
Scott Rifenbark
74bf586c94 documentation: Fixed links for "build-directory" term.
Fixes [YOCTO #11630]

Moving the "Yocto Project Terms" section from the dev-manual to the
ref-manual broke several links to the id "build-directory".  I fixed
these to reference into the ref-manual now.

(From yocto-docs rev: debe2ae8ce203ebe0f1cee0de54124c15df8bb7e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:42 +01:00
Scott Rifenbark
45b16e35b6 documentation: Fixed links to "bitbake-term"
Fixes [YOCTO #11630]

Moving the "Yocto Project Terms" section from the dev-manual to
the ref-manual.  Doing so caused all the links to the id
"bitbake-term" to break.  These had to be individually fixed.

Discovered two unresolved references that were a consequence of
moving that section to the ref-manual.  These were fixed as well.

(From yocto-docs rev: 829ca6b64562f00a69f3956e9636c7edaa90ce16)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:16:42 +01:00
Scott Rifenbark
ed0ecc7b76 dev-manual, ref-manual: Reorganized "Other Information"
Fixes [YOCTO #11630]

The exhaustive list of useful links and references to other
YP documentation existed in the dev-manual.  This is not the correct
place for this type of reference information.  I have moved that
list to the ref-manual where it should be.  The dev-manual now
simply provides a link into that section.

(From yocto-docs rev: eeceb597988134ced85aab4b9ddaeed923f17b03)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14 10:19:25 +01:00
Scott Rifenbark
741dddf11a dev-manual, ref-manual: Reorganized Bugzilla information
Fixes [YOCTO #11630]

Reorganized the way the information about entering bugs using
Bugzilla is arranged in the documentation set.  The dev-manual now
has a section that is purely procedural and steps the user through
the process of logging a new bug in the Bugzilla system.  The
ref-manual has a conceptual section that introduces the YP
implementation of Bugzilla by simply telling the user what it is
and what what its purpose is.

(From yocto-docs rev: 4bfba345010be7bc2866b819b9754bb06f93c91f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14 10:19:25 +01:00
Kristi Rifenbark
0dae0865ba dev-manual: Corrected grammar error
(From yocto-docs rev: 0d432a6890316207f93c149b865d4a9fc020bfa0)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14 10:19:25 +01:00
Kristi Rifenbark
6b32207239 dev-manual: Edited grammar error
(From yocto-docs rev: d02aedcd3cf9e30d5d1633ee234af3fcb4a570e3)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14 10:19:25 +01:00
Kristi Rifenbark
6a54099d1d dev-manual: Edited intro para to devtool upgrade figure
The introductory paragraph for this figure was a cut/paste
problem from previous devtool figures.

(From yocto-docs rev: c02a2a57889bbdcd7e83ab9e2458397189bbb980)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14 10:19:25 +01:00
Kristi Rifenbark
aadfed276c dev-manual, sdk-manual: Corrected grammar error
(From yocto-docs rev: ca0843e7651d25e37295094770ca3a97f9150bbc)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14 10:19:24 +01:00
Kristi Rifenbark
0050fc51d0 dev-manual: Updated "Kernel Modification Workflow" config file location
Warning in step 5 indicated the wrong location for config file.
Updated with new location and referenced an illustration to
show an example.

(From yocto-docs rev: e853e5b89f1dbd7399909064b50bc59e06302560)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14 10:19:24 +01:00
Scott Rifenbark
7d231fb681 dev-manual: Removed last paragraph of BSP workflow section.
This paragraph had some links to old stuff.  Removed the whole
paragraph.

(From yocto-docs rev: 95c1f348ed018c697cc996bc962787ede056b94b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14 10:19:24 +01:00
Scott Rifenbark
3cf074a195 dev-manual, mega-manual: Updated kernel overview tree structure figure
This figure was a bit out of date.  I updated a few of the file
names.  Figure needs to reside in the Figures folder of both the
dev-manual and the mega-manual.

(From yocto-docs rev: 1e76477810b6be095f9ca190c9a8f0276ee4b8f9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14 10:19:24 +01:00
Scott Rifenbark
635c5c60dc dev-manual: Slight wording change to be clear.
(From yocto-docs rev: f8b0f3e01249ab94520137ecc60dcc08620a2a96)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14 10:19:24 +01:00
Scott Rifenbark
8cff6961a9 dev-manual: changed git configuration file name
I changed the git config file to ~/.gitconfig

(From yocto-docs rev: 0d4f43944b911ee23dd03b5f503173478d6c396d)

Signed-off-by: Scott Rifenbark <scottrif@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14 10:19:24 +01:00
Scott Rifenbark
f29a05dd85 dev-manual: Formed ordered list for email patch procedure
The section that describes how to create a patch and send it via
email is really an ordered procedure.  I recast the list of steps
using numbers instead of bullets.

(From yocto-docs rev: c2d2256ca6d8c8b837bae87a5bd8a3118553935c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14 10:19:24 +01:00
Scott Rifenbark
3edf5dc104 dev-manual, sdk-manual: Fixed link to Eclipse section
The YP doc set was using a link to an out-dated video that
showed how to configure and run Eclipse.  The video was very
old and Jessica suggested just removing it.  So, I replaced
all occurrences of the link to the up-to-date appendix in the
SDK manual that provides information on the latest supported
version of the Eclipse IDE.

(From yocto-docs rev: b4af1a79078352df5558e20c0b9cfa97fa141abc)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14 10:19:24 +01:00
Scott Rifenbark
22bcc7623c dev-manual: Fixed broken link into the setting up Eclipse section
The link to the section on how to set up Eclipse had been broken
for a while.  I fixed the link so that it goes to the appropriate
section (appendix) in the SDK manual.

(From yocto-docs rev: 873c2c53f661b18936595068d75b954e07774621)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-14 10:19:24 +01:00
Scott Rifenbark
374f3d6be2 Documentation: Created YP 2.4 "latest" docs
Updated poky.ent to use 2.4 variables and numbering

Updated mega-manual.sed to use "2.4" string for links

Updated all manual revision tables to use "2.4" and
"Usually October, 2017" string.

(From yocto-docs rev: 17ec7da6ab3fd450c2010812f7ad689288b12dcc)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-04 08:47:14 +01:00
Scott Rifenbark
0241215d3e ref-manual, dev-manual: replaced "depexp" with "taskexp"
(From yocto-docs rev: 3d7a13357a12b70d0c46b8aafdaf2ace20dcb970)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-10 12:13:32 +01:00
Scott Rifenbark
d815dfbea3 dev-manual: Cleaned up "Gdbserver" term
This should be "gdbserver" when referred to generically.

(From yocto-docs rev: 83b2be50e34b0c07cce1f27b55e595752b80b3ea)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-10 12:13:32 +01:00
Scott Rifenbark
cbea3d8b6b dev-manual: Updated a few occurrences of "dnf" to "DNF"
These depend on context.  In general, "DNF" is the preferred
terminology unless directly referring to an application or such.

(From yocto-docs rev: 29012a8f8e21b964e1ea6d32841dffa8dae7df9f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-10 12:13:32 +01:00
Scott Rifenbark
bcf22c0bb6 dev-manual: Changed "Dnf" to "DNF" for consistency
(From yocto-docs rev: 22ca6c591fd28995a5444635dc787c67f8af822a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-10 12:13:32 +01:00
Scott Rifenbark
b1dc0ee121 ref-manual, dev-manual: Completed first draft of 2.3 migration section.
(From yocto-docs rev: 42ab9e34da640b46d39741c9c83648dc65518ec1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-10 12:13:32 +01:00
Scott Rifenbark
c0dc8d492e dev-manual, ref-manual: Updated various wordings and links
Fixes [YOCTO #10995]

I implemented various wording changes based on feedback from the
review.  One section title changes so some links in the ref-manual
and the dev-manual needed updating as well.

(From yocto-docs rev: 43a35a311a006d47db50602822e44ab431ca3e43)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-04-20 08:16:38 +01:00
Scott Rifenbark
3db3344859 ref-manual, dev-manual: Updates to support recipe-specific sysroots
Changes covered several areas.  Version 2.3 of the YP now supports
recipe-specific sysroots and is not limited to machine-specific
as was prior releases.  Manual changes were as follows:

dev-manual: "Sharing Files Between Recipes" - Wordings were changed
to support the new functionality.

ref-manual: do_prepare_recipe_sysroot task added to the list of
tasks described in "Configuration and Compilation".

ref-manual: Extensive re-write of the "staging.bbclass" section.

ref-manual: Added a section to the build structure for
build/tmp/work/tunearch/recipename/version/.  This section breaks
down the recipe-specific subdirectories used to create (stage)
the sysroot.

ref-manual: New section (entry) for the do_prepare_recipe_sysroot
task in the task chapter.

ref-manual: Added a variable glossary description for the
SSTATE_SCAN_FILES variable.

In addition to these changes, I sprinkled in a liberal amount
of cross-referencing for the readers pleasure.

(From yocto-docs rev: 3a8ca96861f4c5d3badb91d0cdc5a3df513d4e59)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-04-18 15:51:44 +01:00
Scott Rifenbark
94467d5087 dev-manual, ref-manual: Edits to the "Incrementing Binary Package" section.
Fixes [YOCTO #10995]

I applied some revisions to the related sections for incrementing
a binary package version and revision sections.  Mainly clarified
terminology and pulled the sections into one single section head.

I also cleaned up referencing to all these sections throughout the
YP manual set (i.e. the ref-manual).

(From yocto-docs rev: 7deda18dd496cc383c5de71a10f2b11b1ca0688f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-04-12 19:35:00 +01:00
Scott Rifenbark
f9e7fba02f dev-manual, ref-manual: Created new section on linear revision for packages
Fixes [YOCTO #10995]

For the dev-manual, I added a new section on incrementing package
revision numbers that explains how the build system uses various
variables to create linearly numbered revisions for packages.

For the ref-manual, I cross-referenced into the new section from the
AUTOSRC and SRCREV variables.

(From yocto-docs rev: 53c3092e0f0293f4db0a88659abb4cf1c93f208c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-04-12 19:35:00 +01:00
Scott Rifenbark
beb301c03a dev-manual: Added section on using headers to interface with devices
Fixes [YOCTO #8596]

Added a new section to describe the right way to use headers to
interface to a device or custom Linux kernel API.  Too often a
user wants to modify the libc header file, which absolutely wrong.
This new section provides some guidance.

(From yocto-docs rev: 960c49bf6446398a9efb2d018d09d63b49e97196)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-04-12 19:35:00 +01:00
Scott Rifenbark
e2232e6813 dev-manual, ref-manual: Added PACKAGE_WRITE_DEPS and concept support
Fixes [YOCTO #11274]

When a post-installation or pre-installation script uses tools that
have dependencies, you need to specify the tools using the new
PACKAGE_WRITE_DEPS variable.  I added this information at the end
of the "Post Installtion Scripts" section in the dev-manual.

I also added a new variable entry for the PACKAGE_WRITE_DEPS variable
in the glossary.

(From yocto-docs rev: 4d130b63cba5ebabd4af52b62421d387a4b54353)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-04-12 19:35:00 +01:00
Scott Rifenbark
e0a4972087 dev-manual: Added cross-reference to QA and Test Infrastructure section.
Fixes [YOCTO #10887]

I placed a small paragraph at the end of the introduction to the
"Performing Automated Runtime Testing" section that points into the
new section on QA and testing infrastructure in the ref-manual.

(From yocto-docs rev: 493051e1770e07b89c19a1f235f1dd226610c77a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-04-12 19:35:00 +01:00
Scott Rifenbark
c53ba427ef dev-manual: Added YP Compatibility feature
Fixes [YOCTO #10596]

No information existed for the version 1.0 YP Compatibility Program
for layers.  Additionally, the version 2.0 flavor is adding a script
as part of the application process.  I put in a new section on the
whole topic.  Also, integrated the information into relevant sections
with some cross-referencing.

(From yocto-docs rev: 6341705d4c08901b2657c489f4e995968db00d85)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-04-12 19:34:59 +01:00
Scott Rifenbark
c015fed613 dev-manuual: Replaced "smart" with "dnf"
Fixes [YOCTO #9675]

I missed one occurrence of changing "smart" to "dnf" in the
Enabling Tests section.  Corrected.

(From yocto-docs rev: b5106c7a38f51dbfea6d200072039f624be7ed3a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-31 12:14:18 +01:00
Scott Rifenbark
1a4c0bfafd dev-manual; ref-manual: Updates to replace "smart" with "dnf"
Fixes [YOCTO #9675]

Various fixes to replace the "smart" package manager references
with "dnf".

(From yocto-docs rev: 721dc7fb637c4c03534eb19f61b0b08a7303826d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-31 12:14:17 +01:00
Scott Rifenbark
17e46eff4a dev-manual: Added cross-reference note into the BSP Guide.
The section in the dev-manual that introduces BSP Layers for the
first time was missing a general link to reference into the BSP
Guide to help the user understand BSP Layer structure.  I added
a note.

(From yocto-docs rev: c515e30a551e96e11091c3850f7eed1b034abdad)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-24 23:44:03 +00:00
Scott Rifenbark
b3e2ecaae2 documentation: Added support for "pyro" name and May release date.
poky.ent - changed the "tbd" and "TBD" strings to "pyro" and
           "Pyro", respectively.

Manual Head Files - Updated the manual history table with the
           May release month.

(From yocto-docs rev: 076226d2986d0cf69685121e4342f50c1603fc7b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-24 23:44:03 +00:00
Scott Rifenbark
f574b9f074 dev-manual, ref-manual: Added support for WKS_FILE_DEPENDS variable.
Fixes [YOCTO #11017]

There is no current way to specify or list plug-in dependencies
when building a Wic image.  The variable WKS_FILE_DEPENDS was introduced
to allow the user to use this in the recipe building the image.
I added a description and example of the variable to the ref-manual
variable glossary.  I also cross-referenced the variable in the
"Plug-ins" section of the dev-manual to point to the variable for
more information.

(From yocto-docs rev: 5a1072499ab80f74ffec6af2cc0b2f1987843a25)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-24 23:44:02 +00:00
Scott Rifenbark
70872b9468 dev-manual: Fixed formatting error for arguments.
(From yocto-docs rev: 53153191b83007763d41d9aa8356d88bce88a3d0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-24 23:44:02 +00:00
Scott Rifenbark
6273f91c6a dev-manual: Fixed grammar error - article agreement.
(From yocto-docs rev: 39a7810c668936586455bf8a0331371a27d2dd7e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-24 23:44:02 +00:00
Scott Rifenbark
2ad42e587a dev-manual: Add explanation for signing RPM packages and using signed packages
Fixes [YOCTO #11048]

No documentation existed for telling the user how to create signed
RPM packages or for how to use signed package feeds.  I have created
a new section on the topic to describe both scenarios.

(From yocto-docs rev: cbdde75f06b1fc190b8e4f7f93f302dc238e3e7f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-24 23:44:02 +00:00
Scott Rifenbark
90399afd54 dev-manual: Minor corrections to maintaining Open Source lic. comp.
The section "Maintaining Open Source License Compliance During
Your Product's Lifecycle" had a vew minor typo things (e.g. duplicated
word and some formatting issues).  I fixed these.

(From yocto-docs rev: 67beb658445e79129d8aae1739bb33c000367107)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-02-19 06:59:51 -08:00
Scott Rifenbark
77afd14e81 documentation: Updated "latest manual" note on title page
Fixes [YOCTO #10076]

The note on the title page for each manual was brief regarding
where to find the latest version of the manual.  I updated the
note to have more detailed information on finding current,
alternate, and latest versions of the manual based on YP
releases.

(From yocto-docs rev: 0ec81465296a7a78309d3039af4d00caa52d2285)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-02-19 06:59:51 -08:00
Scott Rifenbark
faee9d8c37 dev-manual: Updated the "How to Submit a Change" section.
Fixes [YOCTO #10905]

I updated the section with suggested improvements for completeness.
The section has been broken into more subsections and provides the
reader with more direction on mailing lists based on components
changed.

(From yocto-docs rev: f7c9010c14d96c64d00ca32e2e217d2dd1343919)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-01-20 11:57:25 +00:00
Scott Rifenbark
3ecc502b8d dev-manual: Added section on bmap-tool to flash images
Fixes [YOCTO #10621]

bmaptool is integrated into the OpenEmbedded build system but is
not documented.  I added a new section describing how to flash an
image to media using the tool.  Also, updated a small section in the
Wic part of the manual that used "dd" to flash an example.  I added
a bmaptool counterpart here and referenced the reader back to the
main new section.

(From yocto-docs rev: 98ebe9acccceea2b833c1372a3e664befd1b6aef)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-01-11 17:23:18 +00:00
Scott Rifenbark
a8e9faac40 dev-manual: Added section on bmap-tool to flash images
Fixes [YOCTO #10621]

bmaptool is integrated into the OpenEmbedded build system but is
not documented.  I added a new section describing how to flash an
image to media using the tool.  Also, updated a small section in the
Wic part of the manual that used "dd" to flash an example.  I added
a bmaptool counterpart here and referenced the reader back to the
main new section.

(From yocto-docs rev: 83a9a3aa5f20c7f389306eea9213eabea997aba1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-01-11 17:23:18 +00:00
Scott Rifenbark
50074dfafa dev-manual: Added cross-reference for tool-chain installation.
(From yocto-docs rev: f57728c63cc83c44682fb5a109808a17e1f18485)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-01-11 17:23:17 +00:00
Scott Rifenbark
4460bed6c2 dev-manual: Updated "Building an Initial RAM Filesystem (initramfs) Image" section
Fixes [YOCTO #7096]

Applied a couple review comments to the section to clarify where
to set key variables.  Also fixed an incorrect variable name used
to specify the *.cpio file.

(From yocto-docs rev: 24861b36804cbd636aafc36b1918bcfe33ca3811)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-01-11 17:23:17 +00:00
Martin Vuille
5d64b8e076 dev-manual: Fixed "recipetool create" example
Fixes [YOCTO #10763]

The final example in the section describing how to create
the base recipe using receipetool create was wrong.  I updated
it to use the -d option in addition to the -o opetion.  I also
changed the description to match appropriately.

(From yocto-docs rev: 8cc6d5e21532eeaac0e6d9ace3e0b58803a9804e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-01-11 17:23:17 +00:00
Scott Rifenbark
ecaab75be6 dev-manual, ref-manual: Created new section on initramfs
Fixes [YOCTO #7096]

We did not document how to create an initramfs image to be included
with a kernel build.  Various variables sort of inferred the
knowledge.  I created a new section in the "Common Tasks" section
of the dev-manual that describes how to create an initramfs image.

Also, I updated the kernel.bbclass reference section to point back
to the new "how-to" section.

Finally, I also created a bunch of cross-reference links from various
related variables back to the new "how-to" section.

(From yocto-docs rev: 289dfbd5d24241e42446a043104eecd6dca76f13)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-01-11 17:23:17 +00:00
Scott Rifenbark
d229fded3e ref-manual, dev-manual: Removed term "wic-partitioned"
This term was incorrect and I have replaced it with the
term "partitioned."

(From yocto-docs rev: 50dd5c6994a2f799fdaf1ccbf7138b0074e981ee)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-01-11 17:23:17 +00:00
Scott Rifenbark
27751642cd dev-manual: Updated to the "Creating Partitioned Images" section
new information on how wic works

(From yocto-docs rev: 7b6a54a593a678442541b1fa6847498a792183c7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-01-11 17:23:17 +00:00
Scott Rifenbark
12a0ee049e dev-manual: Added note about RPM not dealing with post-install
Fixes [YOCTO #10351]

I added a note to the "Post Installation Scripts" section of the
"Writing a New Recipe" section to call out the fact that the
RPM package manager will not install packages on the target when
any RPM post-install script returns a non-zero exit code when
the script is run on the target.

(From yocto-docs rev: 8565b0ba874f3357500a91640c0f77077c83b8d6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-11-23 11:10:35 +00:00
Scott Rifenbark
479fbee840 ref-manual, dev-manual: Added references to SYSROOT_DIRS
Fixes [YOCTO #10692]

I updated the STAGING_DIR variable description to have a reference
to the SYSROOT_DIRS variable as well as the "Sharing Files
Between Recipes" section of the dev-manual.

I also updated the "Sharing Files Between Recipes" section so
that the role of SYSROOT_DIRS is explained and actually used
in an example to add another directory.

(From yocto-docs rev: 6539fcf632cfa3f076f874535ee9fc7ac291fbce)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-11-23 11:10:35 +00:00
Scott Rifenbark
6ce2cdcc93 documentation: Updates to support developing 2.3 YP docs
Changes to the following:

 * All manual revision tables to indicate a 2.3 release proposed
   for April of 2017.

 * Updated the poky.ent file so that all variables needed reflect
   2.3 values.

 * Updated the mega-manual.sed file so that processing of links in
   the mega-manual work for a 2.3 release.

(From yocto-docs rev: 926e282c17b67c79b94a0b62a0b18bfbe0b26c40)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-11-16 10:38:42 +00:00
Scott Rifenbark
a68b471de3 dev-manual: Fixed typo for "${INC_PR}.0"
The string appeared in the text as "$(INC_PR).0".  So, fixed
it to be proper with the curly braces.

(From yocto-docs rev: 0e4ca6cd3d0eae847243fc624c5f119d004cf40c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-11-16 10:38:42 +00:00
Scott Rifenbark
0f86c1d899 dev-manual: Updated "Exporting Tests" section
Fixed [YOCTO #10588]

This section was confusing due to the fact that it used an actual
set of IP addresses and image name where they should be clearly
called out as examples.  Fixed it.

(From yocto-docs rev: 4682899c7b70c730256412bf08f469c457af1c2e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-11-16 10:38:41 +00:00
Scott Rifenbark
0df906b779 dev-manual: Added section for multi-configuration support
I added a new section in the "Common Tasks" chapter to support
the fact that BB can now build for multi-configurations.

(From yocto-docs rev: aa21aeb2f3d2f9d5a3a6e7175b7c6f13da5f608e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-25 17:55:37 +01:00
Scott Rifenbark
b2f1d21ff3 dev-manual: Re-wrote the remote GDB debugging section.
Fixed [YOCTO #9481]

Complete re-write based on Mark Hatle's steps.  I converted
from sub-sections to an ordered list.

(From yocto-docs rev: f83bfe5d3dc012b924b6870672d7260a9c0bc3ee)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-13 23:16:47 +01:00
Scott Rifenbark
551f7d87c9 dev-manual: Applied review comments to "Packaging Externally Produced Binaries"
Fixes [YOCTO #10392]

Moved the last bullet item from the list that was about
DEPENDS to a note form above the list.  This was done because
the stuff for DEPENDS is more general.

(From yocto-docs rev: 2879d97b14322f1f9495288fc7f2298a186c5f68)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-13 23:16:46 +01:00
Scott Rifenbark
96b9007053 dev-manual: Updated "Packaging Externally Produced Binaries"
Fixes [YOCTO #10392]

People often needlessly put [noexec] on tasks, making the recipes
more complicated than they need to be.  I updated the first bullet
item in this section to more clearly explain how to do this.

Also, added a new bullet item to the end to point into the DEPENDS
variable for more clarification.

(From yocto-docs rev: c61e61c1a5f9524c50bfc26335ea6c2027cafd19)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11 08:51:22 +01:00
Scott Rifenbark
b1e4d96e28 documentation: Updated Manual revision table for 2.2
Added string "October 2016" as the release date.

(From yocto-docs rev: db40986677746afbbb138d9cbe3885111550b7c5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11 08:51:22 +01:00
Scott Rifenbark
5f146e508b dev-manual: Added new section on recipe style guidelines
Fixes [YOCTO #10360]

Added a new section to reference into the OpenEmbedded Styleguide.
This will help people writing new recipes to conform to known
styles.

(From yocto-docs rev: 40c12742c78f5aba5bb4e43f759e8c478470fd83)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11 08:51:22 +01:00
Scott Rifenbark
81698ab05d dev-manual: Fixed missing quote in SRC_URI example.
Fixes [YOCTO #10360]

(From yocto-docs rev: 4a8fce4962ca77f6840294f7942fffd0c3479874)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11 08:51:21 +01:00
Scott Rifenbark
e2083c04c7 dev-manual: Fixed IMAGE_FEATURES examples in debug section.
Fixes [YOCTO #9554]

In the examples, I changes "IMAGE_FEATURE" to "IMAGE_FEATURES_append"

(From yocto-docs rev: 3fc2cc217a0a67b3e0739c6a235ab8e350c4b7c3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11 08:51:21 +01:00
Scott Rifenbark
6ec45ef53d dev-manual: Update to GPL file finder script.
Fixes [YOCTO 10323]

Made a code change to the example script that helps a user
locate GPL files.

(From yocto-docs rev: bd02012de75f0c30887d3a5bb4aa219703a3ee1c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11 08:51:21 +01:00
Scott Rifenbark
5d8a968ecd dev-manual: Applied review changes to GNU debugging section.
Fixes [YOCTO #9554]

Fixed a grammar problem.  Also, provided correct syntax to
two examples.

(From yocto-docs rev: 10eeaf036542696a7037f667feda114dc63527f3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28 15:02:33 +01:00
Scott Rifenbark
b064c34f12 dev-manual: Updated the example to identify GPL files.
Fixes [YOCTO #10323]

In the Providing the Source Code section, I replaced the 3-line
code example that returns GPL files.  The bits I put in are a
script that does the trick.  The 3-line example was not working.

(From yocto-docs rev: a07873d46b5135555961499c6ce8f0b6b8bf2c8f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28 15:02:33 +01:00
Scott Rifenbark
2199b68fc8 dev-manual: Updated the devpyshell section
Fixes [YOCTO #9166]

I applied some review comments to the section.  Pulled some stuff
out that did not apply.pdated the devpyshell section

(From yocto-docs rev: 7300358570de4da94ff5f22afd30128ef8dd0f13)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28 15:02:33 +01:00
Scott Rifenbark
99b9efb993 dev-manual: Updates to the on-target debugging section.
Fixes [YOCTO #9554]

I applied some review comments for the section on using GDB
on the target for debugging.  Included a new note on optimizations
considerations.

(From yocto-docs rev: 23f0dd82f682ea39849de0f589ee1ebfb16be749)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28 15:02:33 +01:00
Scott Rifenbark
bbc7a646ec ref-manual, dev-manual: Add information on devpyshell
Fixes [YOCTO #9166]

In the dev-manual, I added a new section titled "Using a
Development Python Shell."  This section is similar to the
section that talks about using devshell.  The section is
tied to a reference section on the do_devpyshell task.

In the ref-manual, I entered a new task reference for the
do_devpyshell task.  It is brief and references into the
new section in the dev-manual.

(From yocto-docs rev: 637128809e298c3d5e660f6da2366f8e9e307218)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28 15:02:33 +01:00
Scott Rifenbark
9f2cf76e09 dev-manual: Added new GDB debug requirements section for target
Fixes [YOCTO #9554]

I added a new section titled "Debugging with the GNU Project
Debugger (GDB) on the Target" that provides requirements for
this type of debugging.

(From yocto-docs rev: 5d15c6c5f2030395f9faea8a5ef3ead1b98042d8)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28 15:02:33 +01:00
Scott Rifenbark
924966f634 dev-manual: Updated the Known issue for QEMU not working in usermode
Fixes [YOCTO #9285]

Altered the wording to more accurately reflect the issue.

(From yocto-docs rev: 66cda9997a6c17752903a0b5600fb8cae98566e9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28 15:02:33 +01:00
Scott Rifenbark
8a8349be29 ref-manual, dev-manual: Updates for "staging" discussion and variables.
Fixes [YOCTO #8631]

These fixes cover the following:

 * New glossary entry for SYSROOT_DIRS
 * New glossary entry for SYSROOT_DIRS_NATIVE
 * New glossary entry for SYSROOT_DIRS_BLACKLIST
 * New section titled "Sharing Files Between Recipes" in the
   dev-manual's "Writing a New Recipe" section.

(From yocto-docs rev: e541a3c8967f51b903d9dd7978009f4fa7c2f014)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28 15:02:33 +01:00
Scott Rifenbark
1c594557f7 dev-manual: Added new "Dependencies" section to writing new rec.
Fixes [YOCTO #9679]

I added a new section titled "Dependencies" inside the section
that talks about writing a new recipe.  This section details
both build-time and runtime dependency behavior and conditions.

(From yocto-docs rev: 37305ea09473dcaee2db4f9cc37c7ce0fc33c52a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28 15:02:33 +01:00
Scott Rifenbark
b8ad433ff3 dev-manual: Applied review edits to the "writing new recipe"
Applied various edits to the "Writing a New Recipe" section.
Several nits.

(From yocto-docs rev: 17818ff89805e0df3a0445f64a4f9133550fa7d0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28 15:02:32 +01:00
Scott Rifenbark
285931e0d4 dev-manual, sdk-manual: Applied review comments for SDK movement
I applied several nits across the manuals based on reviewer
comments.  All these corrections relate to the task of shuffling
topics around that have to do with the extensible SDK and the
devtool.

(From yocto-docs rev: 9f8079adc7fa2897fd885aff8e64f9721212e9c7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28 15:02:32 +01:00
Scott Rifenbark
959a062096 sdk-manual, dev-manual: Applied SDK review edits.
* Removed the note box formatting for the cross-reference
   from the sdk-manual and dev-manual sections that
   talk about devtool.  The reference is now non-note
   form and goes to the ref-manual devtool quick ref.

 * Added devtool upgrade as a third item in the list that
   introduces methods to use devtool.

 * Fixed the working on the devtool finish step 5 for both
   the dev-manual and sdk-manual.

 * Renamed the new chapter that describes different projects
   you can use devtool on.  The focus is on using the SDK
   toolchain directly.

 * Scrubbed the entire sdk-manual for the term "toolchain
   installer" and replaced with "SDK installer".

(From yocto-docs rev: 6d4daef49cc6d54a700a8c3965c9e8814f75d20a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28 15:02:32 +01:00
Scott Rifenbark
39639ad3ea dev-manual: Updates to the "Writing a New Recipe" section.
Made several improvements to this section.

 * fixed a typo where a YP release was referred to as 7.1
   instead of 1.7

 * Added a note box to the "Using Variables" list item
   elaborating on the expansion behavior.

 * Removed the detail around the WORKDIR discussion.

 * In the "Loccate or Automatically Create a Base Recipe",
   I added the devtool add method to the list of ways to
   create a base recipe.

(From yocto-docs rev: 79c86fc3653c747ae42f08528063a8984cdd3b4d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28 15:02:32 +01:00
Scott Rifenbark
ed6a5495a1 documentation: devtool upgrade and quick ref changes to mult manuals
Did the following:

 * Added the devtool upgrade flow to the SDK manual.
 * Removed the devtool Quick Reference from the dev-manual and
   added it as a new chapter to the ref-manual.
 * Made sure all the links and cross-references work now with the
   moved material.
 * Updated the Make file so that the manual set builds correctly
   regarding the new chapter in the ref-manual.
 * Created cross-referencing notes in both the sdk-manual and the
   dev-manual to the newly located devtool Quick Reference chapter.

(From yocto-docs rev: fda0bf68b3654b1b96407d552c5254657465b5fc)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28 15:02:32 +01:00