Commit Graph

1492 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