Commit Graph

1861 Commits

Author SHA1 Message Date
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