Commit Graph

4742 Commits

Author SHA1 Message Date
Scott Rifenbark
2f7da70a25 brief-yoctoprojectqs: Added link to getting started manual.
Provided a bullet item to the Getting Started manual in the
"Where to Go Next" section.

(From yocto-docs rev: ce4edc521d19b3c8025e950061cc962ca88fa29e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:06 +01:00
Kristi Rifenbark
ae2efdb664 sdk-manual: Fixed duplicate link
(From yocto-docs rev: 53da7ae95f499bcfb80d4f04b834bf6ade71d2ff)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:06 +01:00
Scott Rifenbark
5d7313d298 bsp-guide: Fixed note on title page to have correct title.
(From yocto-docs rev: 30455141776c86def4721e4dbe97b0c0a6e27ddd)

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
Joshua Watt
f2e51380fb ref-manual: Updated the SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS variable
Describes the new wildcard syntax

(From yocto-docs rev: e91db865686e7b1b9b21cb9aea892b0ed8884438)

Signed-off-by: Joshua Watt <jpewhacker@gmail.com>
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
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
fe1419631c bsp-guide: Added new section for creating layer using bitbake-layers
Created detailed example using the BeagleBone BSP.

(From yocto-docs rev: 7701dc2bd94ae7ee3e4aee37ac97174ad445d286)

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
424f544ecd ref-manual: Added variable description for SPL_BINARY
(From yocto-docs rev: 00e579123540006c364f7751a37e29c74acf361b)

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
dbf6a1f778 ref-manual: Updated the IMAGE_BOOT_FILES varaible.
Added a final paragraph that provides some cross-referencing to
the sections that describe how to use Wic and to the Wic
reference chapter.

Also, shortened the DOC info line.

(From yocto-docs rev: 4ba5d0119caa3696187537f5b4cc9c64ca00e205)

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
2bb3bcf49c ref-manual: Updated SERIAL_CONSOLE and SERIAL_CONSOLES variables.
Added a link to the "getty" term.

(From yocto-docs rev: d21fe1ea33353e15c135af7fc302ffe636310541)

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
efa4b3040d ref-manual: Updated IMAGE_INSTALL variable description.
Minor edits for clarification.

(From yocto-docs rev: fdef057927b7b0dba64b9b7f952108fdb9c97f34)

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
85976e1d32 ref-manual: Updated EXTRA_IMAGECMD variable.
Added minor edits to clarify that we are talking about an
image type.

(From yocto-docs rev: 14c906aa539d127c88d71d7fb3e628fc225cbd52)

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
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
6b8a529dbf ref-manual: Added new variable description LAYERSERIES_COMPAT
Created a new variable description in the glossary.  This
variable is used in the layer.conf file and needed to be
documented.

(From yocto-docs rev: 5c514c0e90ca920bdf183b1f9449a06b906235ca)

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
cc24d4b4f8 poky.ent: Added two Minus-1 variables for release code names
Many examples in the YP set use the latest release code name
as part of a list and then the "minus-1" code name is literally
typed in.  I think it is time to have a couple ENTITY variables
in poky.ent that will fill in the last release for these examples.

(From yocto-docs rev: 7421d6a0ae85503b205537f08cfd23e28747d835)

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
Kristi Rifenbark
6ee6a14491 sdk-manual: Added new appendix for Neon
Fixed [YOCTO #12417]

(From yocto-docs rev: 9f6b874740b98c5b3eed1c06dcf5fbe687279ca8)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:02 +01:00
Kristi Rifenbark
840dbbfff9 sdk-manual: Removed Mars Appendix
Fixed [YOCTO #12417]

Deleted the appendix.xml file.
Updated the mega manual .xml file to not include
the Mars appendix file.
Updated the sdk-manual.xml file to not include the
Mars appendix file.

(From yocto-docs rev: e7752c3db1aec8d5143e78aab44ec5afaaaf9c76)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:02 +01:00
Scott Rifenbark
80c7ca2c28 kernel-dev: Clean up of "bsp_name" placeholder.
This string is now being presented as "bsp_root_name" in the YP
manual set.  A BSP name is essentially "meta-bsp_root_name".
It was being presented in the manual set as "meta-bsp_name",
which is not technically correct.

(From yocto-docs rev: 9ad25836b2b3ca79aa3430be014871f50205cf9e)

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
ce8c96481e bsp-guide: Updated BSP terminolgy and BBLAYERS ordering
Fixed the way we refer to a BSP name.  It is really
"meta-<bsp_root_name>" rather than "meta-<bsp_name>".  The
name is the whole string and not just the root name.

Also added a tip on ordering the layers in the BBLAYERS
variable in the bblayers.conf file.  Order is important.

(From yocto-docs rev: 9c56238295f5631c496377616ea98b860253e6f7)

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
dcde1a9e33 ref-manual: Added term "container layer"
This is a layer that contains other layers

(From yocto-docs rev: 0cd1881c18e8a63d5f2f078b03fe4e89fd9c75b5)

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
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
8986a6f589 ref-manual: Updated PACKAGES_FEED_ARCHS variable
Added the fact that this variable is really optional.  If  you
don't use it then you are setting up a package feed URI that
will include all supported arcchitectures for the package.
Using it means you are setting up specific URIs for specific
architectures.

Added a "Tip" note box to show how you can use the variable
to whitelist architectures.

(From yocto-docs rev: 009f3551aa61aaf6459fd24105a2e06511b59da3)

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
a2ed012df7 ref-manual: Updated the IMAGE_INSTALL variable description.
I created a two-bullet "Caution" note to highlight the stuff a
user needs to be aware of that can cause problems.

(From yocto-docs rev: 553bc13e5fd350adb15400afe170e587965929db)

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
ed80131abf bsp-guide: Review edits to the kernel layer.
Minor corrections.

(From yocto-docs rev: f7fa509b461d4b187f7f91c184b2de3c619de5a3)

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
52e525544d yocto-project-qs: Added "cd poky" step after cloning example.
(From yocto-docs rev: 3a05201aabc4633ffead17a01ed36cd25529595e)

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
4c6c816da3 getting-started: Review updates for minor wordings and links
(From yocto-docs rev: 51dc5dd5362a8e6d6d558a566554bec34764227f)

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
fdd79ab4cb bsp-guide: Removed deprecated tool sections
I took out the sections at the end of the manual that talked
about the yocto-kernel tool.  This tool is no longer maintained
and there is no equivalent tool.  I also fixed the yocto-bsp
tool to be the bitbake-layers tool.  This involved some
consolidation of sections.

I fixed some links in the kernel-dev and toaster-manual.

(From yocto-docs rev: 20cda99b301b6327d816c4a4cfb3511ad25c987c)

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
7f141cf9a0 bsp-guide: Minor edits to the licensing section.
(From yocto-docs rev: a7d13e2e9f9a947e65f969422202f04784724063)

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
c130396f00 bsp-guide: Updates to Reqs and Recommeds for released BSPs
Updated this section with minor edits.

(From yocto-docs rev: 1bc1dcda5fbab4a66737653164222f4fc5a7289c)

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
c8b2ba7523 bsp-guide: Updated the section on developing a BSP
This section had several out-of-date items.  They are all up
to date now.

(From yocto-docs rev: 247f3eceeccc645a1b556aea433d4cf66399e962)

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
dff40ea5cc bsp-guide: Fixed link to section.
Wrong title used in link.

(From yocto-docs rev: aa42a8752af97aaa4f16c89059eef63700ea48f4)

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
bb0b966827 bsp-guide: Updated BSP development flow figure.
This figure was out of date.

(From yocto-docs rev: 8b649ab3c4667a45f263818c2532b18f2dae9464)

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
776ac4c220 bsp-guide: Scrubbed the BSP structure section.
Made changes to sync the raspberrypi BSP example to what is
really in the source directories.  It was pretty out of date.

Made some minor edits to the sections describing the framework
of the BSP.

(From yocto-docs rev: b222d0988cb365cb1943ee1857e5cfd6b9fe173a)

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
ae64a41af5 bsp-guide: Edits to "Preparing Your Build Host to Work with BSP Layers"
Applied some edits to make the section more up-to-date.  Dumped
minnow as a BSP example for raspberrypi.

(From yocto-docs rev: a40515bad28d07d736e1ddd1832c19b074749d53)

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
4c4076add1 bsp-guide: General edits to "BSP Layers" section
Added more relevant information around the discussion of BSP
layers.

(From yocto-docs rev: 8ca439b0bbfdcf390edb723fd12e8a00d90024e3)

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
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
cfe25e8410 yocto-project-qs: Replaced AUH red-text with real cross-reference.
This reference to tools to help upgrade now exists with the
creation of the section in the dev-manual that talks about how to
upgrade recipes.  I converted the bullet item here in the QS to
point to the actual section.

(From yocto-docs rev: b3d8895fefb99799a7c06abff5cc1604530ee36a)

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
bf839ab5d6 getting-started, mega-manual: Updated YP website page image.
(From yocto-docs rev: 7c0d710a20246c305a0131f030696b036b950774)

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
cf40ca7f5d sdk-manual: Updates to the devtool upgrade flow section.
Did some rewriting to add some references to other sections
in the manual set.  Did some other minor clean up.

(From yocto-docs rev: 7e7be31e96a0e73e230b8596b2431716f254e027)

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