Commit Graph

5750 Commits

Author SHA1 Message Date
Nicolas Dechesne
5f5afa2b96 sphinx: Makefile.sphinx improvements
* add 'clean' target
* use DESTDIR to set the final folder when publishing. e.g.
make -f Makefile.sphinx publish DESTDIR=yp-docs

(From yocto-docs rev: 35c0076bf668a81391ee99316241d180528123fc)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Nicolas Dechesne
2375dda42b sphinx: brief-yoctoprojectqs: fix up all remaining rendering issues
Manual fix up for links, references, code-block, formatting issues..

(From yocto-docs rev: b0c5333c0f9321cdc1f46e1637cd5e9faf6b42a2)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Nicolas Dechesne
2c96878eb0 sphinx: ref-manual: fix heading for oe-init-build-env
In DocBook this section name is set to &OE_INIT_FILE;
variable. However using a substitution pattern in a heading in Sphinx
does not seem to work well. Let's just set the script environment name
here directly, without using a variable. We don't expect to change
this name anyways, so a variable is not really needed.

(From yocto-docs rev: e3347fa41888183c0818852fc07d1e0735406156)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Nicolas Dechesne
6625b264da sphinx: convert 'transitioning to a custom environment'
This page is currently a static web page in the Yocto project website,
in the docs section. While we are converting the whole YP docs into
its own website, let's convert this file as well.

(From yocto-docs rev: 0985ac0570c63e5ac8c4329155ed77f71f56f069)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Nicolas Dechesne
f77ab9bc9c sphinx: convert 'what I wish I'd known'
This page is currently a static web page in the Yocto project website,
in the docs section. While we are converting the whole YP docs into
its own website, let's convert this file as well.

(From yocto-docs rev: 1d4db1f776cdb775f79cd5e2089da01e0d9c43ea)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Nicolas Dechesne
e4b904b21c sphinx: conf: include CSS/JS files, the proper way
html_css_files and html_js_files exist since Sphinx 1.8, and it's the
proper (documented) mechanism to include custom CSS and JS files in
the documentation.

(From yocto-docs rev: 4ae9c426654e33fed4185e5d6e0de76b4a430d84)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Nicolas Dechesne
2a94fe8d6b sphinx: makefile: add publish target
The 'publish' target prepares the sphinx output, so that it can be
transfered on the YP website.

(From yocto-docs rev: f7a06204ef94f9b71174de5364a62ba04deb709b)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Nicolas Dechesne
8fbaa0331c sphinx: conf: a few rendering tweaks
* Remove the 'generated by Sphinx' text on each page
* Add a 'last updated timestamp' on each page
* Remove the trailing 'dot' in TOC numbering

(From yocto-docs rev: 3fa6cf149b3dbbd88b3aa75b6ce1f8bd12817c91)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Nicolas Dechesne
b4779cf090 sphinx: fix up terms related to kernel-fitimage
In this commit: 3aeca3b342e5 (ref-manual: Add documentation for
kernel-fitimage), we added a few terms in the glossary, in the docbook
xml file. However there were a few issues in the conversion to sphinx
which needed to be fixed (missed terms, typo, and wrong placement).

(From yocto-docs rev: 968efa8275e30350cead66613d01f491ee61be4d)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Richard Purdie
ad2e3e6146 sphinx: Add support for multiple docs version
Enhance the sphinx experience/nagivation with:

* Remove the pointless looking parts of breadcrumb navigtation
* Add a document type switcher to the breadcrumb navigation
* Add a version selection switch to the breadcrumb navigation

(From yocto-docs rev: 1823624bdb9ea002d44c9e6d0fd4cd662bff36ad)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Nicolas Dechesne
721edcfd44 sphinx: insert blank below between title and toc
Whenever a TOC follows a title/heading, a blank line is missing. So
let's add it explicitely.

(From yocto-docs rev: 600b6fe7837dd817d32350e1a45431bdcfe8ebbd)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Nicolas Dechesne
18a484df63 sphinx: enable intersphinx extension
This extension can generate automatic links to the documentation of
objects in other projects. We will use it to use cross references with
the Bibtake manual, for example.

(From yocto-docs rev: 5add9854b112f93acba982f237fbfa83aee80d77)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Richard Purdie
8f04fc5824 sphinx: manuals: Move boilerplate after toctree
The boilerplate looks better after the ToC, still not quite
right but the boilerplate can be improved from here.

(From yocto-docs rev: 5e81b9c90f6f45acf26ba146e280bc2659ac14e5)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Richard Purdie
83ebbf63e9 sphinx: history: Move revision history to its own section
The revision history tables look better in their own section,
move them.

(From yocto-docs rev: 27bf0f69b6dc04cea97a023ef52bec2b213d074f)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Richard Purdie
fda08f30b1 sphinx: boilerplate.rst: Sphinx puts the copyright elsewhere
Its elsewhere so drop from boilerplate.

(From yocto-docs rev: b974d1193480e6b005e3e66ab809afdda6a89897)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Richard Purdie
27e80a5e00 sphinx: boilerplate.rst: Drop versions notes as we have better navigation now
Now we have better navigation with sphinx, and alert text about old
versions, we can drop the top two bullts. The remaining bits can just
become text.

(From yocto-docs rev: bb963c8c906644148182a1fc441c676f13cdf6ce)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Richard Purdie
998db0b058 sphinx: releases.rst: Add index/links to docs for previous releases
(From yocto-docs rev: 627f06d19909eff246b08e889068fd1ecddd569b)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Nicolas Dechesne
4b3766b0db sphinx: setup extlink for docs.yoctoproject.org
(From yocto-docs rev: ec5c86368b90e4fb92295780fb10cf29c66c0fb4)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Nicolas Dechesne
f3e7db78ad sphinx: add links to section in the Bitbake manual
Use intersphinx extension to replace links to the Bitbake manual with
proper cross references.

(From yocto-docs rev: 458a6e540a2286ac838812d802306806f77b885c)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Nicolas Dechesne
18df4a8368 sphinx: add links to terms in the BitBake glossary
Using the intersphinx extension, we can refer to terms in the Bitbake
manual using :term:`bitbake:FOO`. This patch implements that, mostly
using the following regexp:

  line = re.sub("`+(\w+)`* <(\&YOCTO_DOCS_BB_URL;)?#var(-bb)?-\\1>`__",
                ":term:`bitbake:\\1`",
                line)

And a handful of manual fixup.

(From yocto-docs rev: d2ed9117fffceb756c4a8f3cb6d39363a271d6d9)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Nicolas Dechesne
28afbf81ec sphinx: fix links when the link text should be displayed
When an hyperlink should be display in the output, there is no need to
any specific syntax or marker, the parser finds links and mail
addresses in ordinary text. Somehow the conversion from pandoc
generated wrong output in the form: ` <link>`__. This patch is
generated using the following Python regexp:

    line = re.sub("` <(https?://.*)>`__",
                  "\\1",
                  line)

(From yocto-docs rev: a35d735a74425dff34c63c086947624467658c40)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Nicolas Dechesne
283ed72d48 sphinx: add links for Yocto project website
In DocBook, variables are used to create custom links (note that it is
not consistent everywhere, since some web addresses are still
hardcoded), such as YOCTO_HOME_URL, YOCTO_GIT_URL, YOCTO_WIKI_URL,
YOCTO_BUGS_URL and YOCTO_DL_URL..

In Sphinx they are replaced with extlinks.

(From yocto-docs rev: d25f3095a9d29a3355581d0743f27b2a423ad580)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Richard Purdie
26c5622bb5 sphinx: Organize top level docs
Clean up the top level docs index to refer to all the manuals
with decent titles/links/layout and match the current website docs
page links.

(From yocto-docs rev: 45138057bf9446dfca7bf1ddef97104df57abe76)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Nicolas Dechesne
6a9fd9bd72 sphinx: toaster-manual: add figures
(From yocto-docs rev: 3b976f4b9a4fdcd8116b557a09fd18b69b684582)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Nicolas Dechesne
6dec8aab0e sphinx: test-manual: add figures
(From yocto-docs rev: 35f1f1e06f79fd28889f188095156890aa898e17)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Nicolas Dechesne
e6c9507240 sphinx: sdk-manual: add figures
(From yocto-docs rev: 33f46470d53790ae986294e1776c5ca23f764976)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Nicolas Dechesne
c7ff908b50 sphinx: ref-manual: add figures
(From yocto-docs rev: 22a371230ab38df0558400a85829fb1e508b6e1d)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Nicolas Dechesne
49493841b5 sphinx: fix up bold text for informalexample container
With DocBook the 'informalcontainer' include a 'title' which was
rendered as bold with CSS. However when using the Sphinx container
directive to create a custom container, it's just content without
title, so make the title bold.

(From yocto-docs rev: 8947e6b71baa6c9bf06751018bc2b98f8be1b6fd)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Nicolas Dechesne
6e4788bb67 sphinx: profile-manual: add figures
(From yocto-docs rev: bfa1c146265d165ddfa1a70488d0f043ec9df2ee)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:34 +01:00
Nicolas Dechesne
ffa58f2985 sphinx: kernel-dev: add figures
(From yocto-docs rev: cd859cca2e6861fbb5bac68c2f6e972285c47dcb)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:33 +01:00
Nicolas Dechesne
0640f19206 sphinx: dev-manual add figures
(From yocto-docs rev: 590ddc11263f00d912d874377199574c123c75b1)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:33 +01:00
Nicolas Dechesne
424567d629 sphinx: manual updates for some links
Some links were not found by the regexp, especially because of they
are spanning across multiple lines. This patch is a manual fixup for
these patterns.

(From yocto-docs rev: 7a5cf8b372903d959d4a1f0882e6198f31f3cba5)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:33 +01:00
Nicolas Dechesne
4bf6fc5281 sphinx: fix custom term links
Some term links have custom 'text', and require manual update, since
they were not caught by the generic Python regexp.

(From yocto-docs rev: 519355ba9daf7630e8d477b2f6f511be51fd8b2e)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:33 +01:00
Nicolas Dechesne
7b87ca796a sphinx: ref-manual: fix typo
The variable name is SSTATE_MIRROR, not STATE_MIRROR, and because of
the typo, it was not caught by the Python regexp.

(From yocto-docs rev: 7347f5343c4995c53da6b9a88a3912453def9669)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:33 +01:00
Nicolas Dechesne
c473fa2292 sphinx: fix internal links
Many of the internal links were not converted probably from DocBook
using pandoc. After looking at the various patterns, the follow series
of 'naive' Python regexp were used to perform some additional
automatic conversion.

Also, since we rely on built-in glossary, all links to terms need to
use the sphinx :term: syntax.

This commit is generated using the following Python series of regexp:

   line = re.sub("`+(\w+)`* <(\&YOCTO_DOCS_REF_URL;)?#var-\\1>`__",
                 ":term:`\\1`",
                 line)

   line = re.sub("`+do_([a-z_]+)`* <(\&YOCTO_DOCS_REF_URL;)?#ref-tasks-\\1>`__",
                 ":ref:`ref-tasks-\\1`",
                 line)

   line = re.sub("`+([a-z_\-\*\.]+).bbclass`* <(\&YOCTO_DOCS_REF_URL;)?#ref-classes-\\1>`__",
                 ":ref:`\\1.bbclass <ref-classes-\\1>`",
                 line)

   line = re.sub("`+([a-z_\-\*\.]+)`* <(\&YOCTO_DOCS_REF_URL;)?#ref-classes-\\1>`__",
                 ":ref:`\\1 <ref-classes-\\1>`",
                 line)

   line = re.sub("`Source Directory <(\&YOCTO_DOCS_REF_URL;)?#source-directory>`__",
                 ":term:`Source Directory`",
                 line)

   line = re.sub("`Build Directory <(\&YOCTO_DOCS_REF_URL;)?#build-directory>`__",
                 ":term:`Build Directory`",
                 line)

   line = re.sub("`Metadata <(\&YOCTO_DOCS_REF_URL;)?#metadata>`__",
                 ":term:`Metadata`",
                 line)

   line = re.sub("`BitBake <(\&YOCTO_DOCS_REF_URL;)?#bitbake-term>`__",
                 ":term:`BitBake`",
                 line)

   line = re.sub("`Images <(\&YOCTO_DOCS_REF_URL;)?#ref-images>`__",
                 ":ref:`ref-manual/ref-images:Images`",
                 line)

   line = re.sub("`Classes <(\&YOCTO_DOCS_REF_URL;)?#ref-classes>`__",
                 ":ref:`ref-manual/ref-classes:Classes`",
                 line)

   line = re.sub("`workspace <(\&YOCTO_DOCS_REF_URL;)?#devtool-the-workspace-layer-structure>`__",
                 ":ref:`devtool-the-workspace-layer-structure`",
                 line)

   line = re.sub("`Open-?Embedded b?B?uild s?S?ystem <(\&YOCTO_DOCS_REF_URL;)?#build-system-term>`__",
                 ":term:`OpenEmbedded Build System`",
                 line)

   line = re.sub("`(OpenEmbedded-Core )?(\(?OE-Core\)? )?<(\&YOCTO_DOCS_REF_URL;)?#oe-core>`__",
                 ":term:`OpenEmbedded-Core (OE-Core)`",
                 line)

It won't catch multiline strings, but it catches a very large number
of occurences!

(From yocto-docs rev: 3f537d17de5b1fb76ba3bee196481984a4826378)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:33 +01:00
Nicolas Dechesne
4cd953989d sphinx: ref-manual: use builtin glossary for the Terms section
Using the builting glossary is well suited for the Yocto Project
'terms' section. Conveniently, all terms will also be added in the
global index.

While converting this to a glossary, also fixed up some content which
was not properly converted by pandoc (such as codeblock sections, or
references in between terms).

(From yocto-docs rev: fce1d16eac1a92f3c6b7bfc74600197b5cb668a2)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:33 +01:00
Nicolas Dechesne
303f1a9ef7 sphinx: conf.py: enable sphinx.ext.autosectionlabel
This extension generates the labels for each section, so that we can
reference section by their title.

(From yocto-docs rev: 910bdad33819116f00fd4f849dcf7484fbebb465)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:33 +01:00
Nicolas Dechesne
a9577eadae sphinx: add a general index
This index is automatically generated by Sphinx, and all terms from
the glossary are listed. It seems very convenient for the Yocto
Project documentation.

The implementation with an 'almost' empty file is tricky. It was
borrowed from:
https://stackoverflow.com/questions/40556423/how-can-i-link-the-generated-index-page-in-readthedocs-navigation-bar

(From yocto-docs rev: 8af595c464b58cf46df7ef067832db5c841e9202)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:33 +01:00
Nicolas Dechesne
17f1c2ce04 sphinx: ref-manual: add revision history table
(From yocto-docs rev: 36d1073119081b9c364f48aedf4086881bef03d6)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:33 +01:00
Nicolas Dechesne
461e2e843d sphinx: add boilerplate to manuals
(From yocto-docs rev: d552acdc60c8a0467b649b95183b87b3345a4f8c)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:33 +01:00
Nicolas Dechesne
54d38a91e1 sphinx: add boilerplate file
A certain amount of boilerplate is added at the beginning of all
documents. In DocBook this is copy/pasted in each file. Let's create a
boilerplate ReST file, which we will include in each document,
wherever it's required.

(From yocto-docs rev: 37e0d5f246c614e62a7c0d4d72a5d6ce9ec5325e)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:33 +01:00
Nicolas Dechesne
44e8d439aa sphinx: conf: add substitutions/global variables
The Yocto Project documentation makes heavy use of 'global'
variables. In Docbook these 'variables' are stored in the file
poky.ent. This Docbook feature is not handled automatically with
Pandoc. Sphinx has builtin support for substitutions however they are
local to each reST file by default. They can be made global by using
rst_prolog:

 rst_prolog
    A string of reStructuredText that will be included at the
    beginning of every source file that is read.

However Sphinx substitution feature has several important limitations. For
example, substitution does not work in code-block section.

yocto-vars.py is an extension that processes .rst file to find and
replace 'variables'. This plugin will do variables substitutions
whenever a rst file is read, so it happens before sphinx parses the
content.

All variables are set in poky.yaml. It's a simple YAML file with pairs
of variable/value, and the file is parsed once during setup. It's
important to note that variables can reference other
variables. poky.yaml was generated by converting poky.ent into a YAML
format.

To use a variable in the Yocto Project .rst files, make sure it is
defined in poky.yaml, and then you can use : &DISTRO_NAME;

For external links, Sphinx has a specific extension called extlinks,
let's use it instead of variable substituions. Note that we
intentionnally did not put the trailing '/' in the URL, this is to
allow us to use :yocto_git:`/` trick to get the actual URL displayed
in the HTML.

(From yocto-docs rev: dc5f53fae8fdfdda04285869dd1419107b920bfe)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:33 +01:00
Nicolas Dechesne
18786fbffe sphinx: conf: update copyright
(From yocto-docs rev: 9a5c74f73f2f00d8dbd3bc4f72973f9e2913b316)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:33 +01:00
Nicolas Dechesne
fd71ce03e9 sphinx: add Yocto project logo
(From yocto-docs rev: 125c70b04a28bf095ed1cd8273ebdc7d1d0b5cfd)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:33 +01:00
Nicolas Dechesne
87f3435b39 sphinx: bsp-guide: add figures
(From yocto-docs rev: 5341150c11270633fdb1428a59a3b7bd72123e7f)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:33 +01:00
Nicolas Dechesne
2c3298d72e sphinx: add CSS theme override
It is possible to override CSS settings from the theme, by providing
custom snippets of CSS stylesheet. Support for that is added in
conf.py file.

The following changes are made:
* remove the overall text width which (set to 800px by default)
* improve the visual output, and colors of links and admonition

(From yocto-docs rev: 0c1e108bc6c452f7cc8c665bee984bd7da281666)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:33 +01:00
Nicolas Dechesne
7ea70a656b sphinx: Add SPDX license headers
SPDX headers have been added to each file, and match the headers used
in the DocBook files.

(From yocto-docs rev: 79dbb0007ae24da4a3689a23e921f2a2638757f7)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:33 +01:00
Nicolas Dechesne
6c445d85f0 sphinx: switch to readthedocs theme
To install this additional theme:
pip3 install sphinx_rtd_theme

(From yocto-docs rev: 9121dbd0a457451d7f7cdffe8fa2717d5e5959ec)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:33 +01:00
Nicolas Dechesne
afde290655 sphinx: overview-manual: add figures
The automatic conversion with pandoc skipped the figures. Add them
manually.

(From yocto-docs rev: 1c2d071b7963490e8126a0b81792bda7a7c0bc8c)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:33 +01:00
Nicolas Dechesne
0b84b3dd76 sphinx: ref-variables: use builtin sphinx glossary
Sphinx has a glossary directive. From the documentation:
This directive must contain a reST definition list with terms and
definitions. The definitions will then be referencable with the 'term'
role.

So anywhere in *any* manual, we can do :term:`VAR` to refer to an item
from the glossary, and create a link.

An HTML anchor is created for each term in the glossary, and can be
accessed as:
<link>/ref-variables.html#term-<NAME>

To convert to a glossary, we needed proper indentation (e.g. added 3
spaces to each line)

(From yocto-docs rev: af16cc4233ae9672698cf2fbb7bf0a78e461122e)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:33 +01:00
Nicolas Dechesne
9bd69b1f1d sphinx: initial sphinx support
This commit is autogenerated pandoc to generate an inital set
of reST files based on DocBook XML files.

A .rst file is generated for each .xml files in all manuals with this
command:

cd <manual>
for i in *.xml; do \
  pandoc -f docbook -t rst --shift-heading-level-by=-1 \
  $i -o $(basename $i .xml).rst \
done

The conversion was done with: pandoc 2.9.2.1-91 (Arch Linux).

Also created an initial top level index file for each document, and
added all 'books' to the top leve index.rst file.

The YP manuals layout is organized as:

Book
  Chapter
    Section
      Section
        Section

Sphinx uses section headers to create the document structure.
ReStructuredText defines sections headers like that:

   To break longer text up into sections, you use section headers. These
   are a single line of text (one or more words) with adornment: an
   underline alone, or an underline and an overline together, in dashes
   "-----", equals "======", tildes "~~~~~~" or any of the
   non-alphanumeric characters = - ` : ' " ~ ^ _ * + # < > that you feel
   comfortable with. An underline-only adornment is distinct from an
   overline-and-underline adornment using the same character. The
   underline/overline must be at least as long as the title text. Be
   consistent, since all sections marked with the same adornment style
   are deemed to be at the same level:

Let's define the following convention when converting from Docbook:

Book                => overline ===   (Title)
  Chapter           => overline ***   (1.)
    Section         => ====           (1.1)
      Section       => ----           (1.1.1)
        Section     => ~~~~           (1.1.1.1)
          Section   => ^^^^           (1.1.1.1.1)

During the conversion with pandoc, we used --shift-heading-level=-1 to
convert most of DocBook headings automatically. However with this
setting, the Chapter header was removed, so I added it back
manually. Without this setting all headings were off by one, which was
more difficult to manually fix.

At least with this change, we now have the same TOC with Sphinx and
DocBook.

(From yocto-docs rev: 3c73d64a476d4423ee4c6808c685fa94d88d7df8)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:33 +01:00
Nicolas Dechesne
c40a8d5904 sphinx: add initial build infrastructure
Used sphinx-quickstart to generate top level config and
Makefile.sphinx, to allow side by side DocBook and Sphinx
co-existence.

(From yocto-docs rev: 01dd5af7954e24552aca022917669b27bb0541ed)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-09-17 10:09:32 +01:00
Usama Arif
6f9d4614e9 ref-manual: Add documentation for kernel-fitimage
This documents kernel-fitimage.bbclass as well as
the variables that are required to use the class
to create a FIT image.

(From yocto-docs rev: 3aeca3b342e5be92be562f6dea6b71390c31b636)

Signed-off-by: Usama Arif <usama.arif@arm.com>
Cc: Richard Purdie <richard.purdie@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-08-08 09:18:12 +01:00
Khasim Mohammed
cacfbbdada wic/bootimg-efi: Update docs for IMAGE_BOOT_FILES support in bootimg-efi
List of files defined using IMAGE_BOOT_FILES are installed into
the boot partition when preparing an image using the wic tool with
the bootimg-efi source plugin.

The corresponding code in bootimg-efi.py is updated to add this feature,
the documentation is updated to reflect the change.

Change-Id: I0d3ea8831440f4255e9d9bcf9f965c8b14331037
(From yocto-docs rev: 41ef4c9cb9882369f02826b6c096014a4d90ee67)

Signed-off-by: Khasim Syed Mohammed <khasim.mohammed@arm.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-07-28 12:40:27 +01:00
akuster
c035205ef6 ref-system-requirements: update supported hosts lists
drop Ubuntu 19, Fedora 28 & 29
Add: Fedora 31, 32 , Centos 8 and Ubuntu 20

(From yocto-docs rev: 08e25f2b2912b8b1102407f5a5f0169e8d5647ff)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-07-19 16:33:45 +01:00
Joshua Watt
f334384df9 virtual/libgbm is the provider of gbm.pc
Providers of libgbm (including mesa) have move to the "virtual/libgbm"
name to provide this functionality. Update the documentation to prevent
confusion.

(From yocto-docs rev: afc290e85bc801549000a6f6d770e2975a313779)

Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-07-16 22:27:44 +01:00
akuster
8ea8f0acb6 ref-manual: Add SPDX license headers
[Yocto #13873]

(From yocto-docs rev: b7d60325c7ca02d38516781ea80376e465c5fd04)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-28 08:36:56 +01:00
akuster
0c4e693ce6 mega-manual: Add SPDX license headers
[Yocto #13873]

(From yocto-docs rev: 0c975232996c11f0d6282879f361334c1fb82dd0)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-28 08:36:56 +01:00
akuster
3872efa157 overview-manual: add SPDX license header
[Yocto #13873]

(From yocto-docs rev: f65ef78ab411d72249fa6889d32a055212a6ce02)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-28 08:36:56 +01:00
Richard Purdie
29bfa17d6c Makefile: Drop obsolete edison/denzil branch conditionals
(From yocto-docs rev: 92120c56c125c6f3af1b1c0df2c9b984cfb2fdef)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-17 16:45:36 +01:00
Mark Morton
5534f6d0a2 test-manual: Fixed codeblock formatting
(From yocto-docs rev: f9df2c8f68ba5732a2d83c99d2b9597ef66dc378)

Signed-off-by: Mark Morton <mark.morton@windriver.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-17 16:45:36 +01:00
Richard Purdie
2bd173f3b5 test-manual: Add SPDX license headers
[Yocto #13873]

(From yocto-docs rev: 33ba40c062ca081dbcffc5400fb49e56d6f7f25e)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-17 16:45:36 +01:00
Mark Morton
444666faa4 New source files and Makefile update for Test Manual
(From yocto-docs rev: d7cff640569a5772f3c366b4136762628fca534d)

Signed-off-by: Mark Morton <mark.morton@windriver.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-17 16:45:36 +01:00
akuster
04118df8b0 toaster-manaul: Add SPDX license headers
[Yocto #13873]

(From yocto-docs rev: 4e07e51e558cda76b870be98d9aeff1a6e7bb5b8)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-17 16:45:36 +01:00
akuster
995d779d55 sdk-manual: Add SPDX license headers
[Yocto #13873]

(From yocto-docs rev: 5b88e5e0f7a71ffefdd5e9c21520bf20692521c6)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-17 16:45:36 +01:00
akuster
411a22c6ec profile-manual: Add SPDX licence headers
[Yocto #13873]

(From yocto-docs rev: 551c4a7f75e2afeb22d2638cc1e9550ec18c8cb4)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-17 16:45:36 +01:00
akuster
38dbf12426 kernel-dev: Add SPDX license headers
[Yocto #13873]

(From yocto-docs rev: 4609c3288be259fcc582fbe946ad6b411aa96e1a)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-17 16:45:36 +01:00
akuster
9a644b0eeb dev-manual: Add SPDX License headers
[Yocto #13873]

(From yocto-docs rev: eaded98195eed8adf3bba89a6b49a45383955785)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-17 16:45:36 +01:00
akuster
7621a05efe brief-yoctoprojectsqa: Add SPDX license headers
[Yocto #13873]

(From yocto-docs rev: 8bf1b566ddeaf6223ed065e9560cc096a18fe14d)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-17 16:45:36 +01:00
akuster
d674526bac bsp-guide: Add SPDX license headers
[Yocto #13873]

(From yocto-docs rev: 0aa081c3f1839833043e116db1729a9de342f72e)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-17 16:45:36 +01:00
akuster
2e9db79a7e adt-manual: Add SPDX license headers
[Yocto #13873]

(From yocto-docs rev: b2d60520431ef71ed2d1decf33605797995cb8f4)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-17 16:45:36 +01:00
akuster
2f9cf90ac8 yocto-docs: Add SPDX headers in scripts and Makefile
[Yocto #13873]

(From yocto-docs rev: b87c540a1a6c0dce4c6010b89d9831442e0e7f70)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-04 13:29:02 +01:00
Richard Purdie
109a501faf poky.ent: Update XXX_HOST_PACKAGES_ESSENTIAL to include mesa for other distros
(From yocto-docs rev: e187f0f858bd4ed2eda10a5140cbc5ec222d7092)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-04 13:29:02 +01:00
akuster
f4856db1e3 poky.ent: Update OPENSUSE_HOST_PACKAGES_ESSENTIAL to include mesa-dri-devel
(From yocto-docs rev: 3003075b29bee696f226533e24ab7121508ca99b)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-06-04 13:29:02 +01:00
Richard Purdie
18577c0e82 poky.ent: Update UBUNTU_HOST_PACKAGES_ESSENTIAL to match recent changes
(From yocto-docs rev: 7ed90c71caa6a23d2ef3b640a880069ca3ee3d24)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-05-30 12:33:26 +01:00
Michael Ho
392ba004f4 ref-manual: add PACKAGE_ADD_METADATA documentation
Add a basic variable definition and a small section to the development
tasks manual for using PACKAGE_ADD_METADATA to add custom metadata to
packages.

(From yocto-docs rev: c5e4d575a771ddd1c970389ce3ace6d6abe68769)

Signed-off-by: Michael Ho <Michael.Ho@bmw.de>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-05-27 11:05:04 +01:00
Quentin Schulz
1f9ebcf8af ref-manual: document new unlisted-pkg-lics insane-skip qa check
The new unlisted-pkg-lics INSANE_SKIP QA check was introduced and need
proper documentation.

This QA check makes sure all licenses listed for all packages built by a
recipe are declared in the recipe LICENSE variable.

(From yocto-docs rev: a50e0628f3d40f9103c9a6ecccde61ad6d7f21c6)

Signed-off-by: Quentin Schulz <quentin.schulz@streamunlimited.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-05-21 12:36:03 +01:00
Robert P. J. Day
ff9ac2b303 ref-manual: delete long-unused comments in variable glossary
As these comments have been around since 2015 and apparently unused,
get rid of hundreds of them.

(From yocto-docs rev: afec5770a22ac51c956e87567bf39e71064e9f04)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-05-17 22:37:19 +01:00
Robert P. J. Day
73a31df937 ref-manual: Remove long-dead PACKAGE_GROUP variable
This was, years ago, deprecated in favour of FEATURE_PACKAGES, so
remove all references, other than the entry in the migration section.

(From yocto-docs rev: 8e5469aadd31bc3de181848aae5733cd7835eefb)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-05-05 13:22:00 +01:00
Robert P. J. Day
2921941876 ref-manual: typo "SSTATE_MIRROR" -> "SSTATE_MIRRORS"
(From yocto-docs rev: d694ff63f4aee0fff6eac0541413c1a36b3b02e2)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-05-05 13:22:00 +01:00
Robert P. J. Day
c3884f4630 ref-manual: IMAGE_TYPES, add tar.zst, delete elf
Update list of legal IMAGE_TYPES to match what's in
image_types.bbclass.

(From yocto-docs rev: 7706a240d6dbbace9a76b4b55427f91bd4afc6da)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-05-05 13:22:00 +01:00
Robert P. J. Day
528c43e931 ref-manual: fix excessive command indentation
(From yocto-docs rev: a95b49eef8f6bfde153677dda8021ffadf29d8f7)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-05-05 13:22:00 +01:00
Mark Morton
f9e1127643 Updated patch for publishing
(From yocto-docs rev: ac352ad7f95db7eeacb53c2778caa31800bd7c26)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-24 15:21:14 +01:00
mmorton
cd25abf777 Added usrmerge to distro-features for Bug 13494
(From yocto-docs rev: 049832ea4c13b01c31911ad0a6f3e170781db6cd)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-24 15:21:14 +01:00
Robert P. J. Day
fe25ef9871 ref-manual: correct "script" dirname to "scripts"
(From yocto-docs rev: 43f042582675f89fcdf81c0cd2ac2602d4282cb3)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-24 15:21:14 +01:00
Maxime Roussin-Bélanger
a44b8d2856 dev-manual: remove postinst false statement
This outdated section contradicts the real behavior expressed in the next
paragraph

(From yocto-docs rev: 77e8a9e03b3bb6e6b6b2adf7796740fb362f189b)

Signed-off-by: Maxime Roussin-Bélanger <maxime.roussinbelanger@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-15 22:56:23 +01:00
Paul Eggleton
c31ddaba1f ref-manual: add migration section for 3.1
Migration information for the 3.1 release.

(From yocto-docs rev: dda13761733c7f3fe672f45b8d06f6c3fcf8cb30)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-15 22:56:23 +01:00
Paul Eggleton
545c067f9a dev-manual: basic updates for npm fetcher changes
Update the npm:// URL and the generated npm recipe, and remove
references to NPM_SHRINKWRAP, NPM_LOCKDOWN and lockdown functionality in
general.

(From yocto-docs rev: bc09233543abbf28adfcc1e214f85ef4c7c56639)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-15 22:56:23 +01:00
rpjday@crashcourse.ca
51ecc1069a ref-manual: update PACKAGECONFIG glossary entry
Update the glossary entry for PACKAGECONFIG in two ways:

1) Explain the recent sixth argument, which identifies conflicting
   features for a given feature.
2) Use a different example, as the librsvg "croco" feature no
   longer works that way.

(From yocto-docs rev: af9bf61a54c059e72c807ca8061a57d6fe74c5fa)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-07 22:00:10 +01:00
Robert P. J. Day
c063e37425 overview-manual: fix obvious typo "ORHNAME"
(From yocto-docs rev: d40485a7eecb8d54179b562f05b4d7b044bb03b2)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-07 22:00:10 +01:00
Robert P. J. Day
4a115c52cf dev-manual: clarify how to select "read-only-rootfs"
For stylistic reasons, clarify the use of both IMAGE_FEATURES versus
EXTRA_IMAGE_FEATURES when configuring a read-only rootfs.

(From yocto-docs rev: 4111e4e70a87400671455ddd873d802d40d6b587)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-07 22:00:10 +01:00
rpjday@crashcourse.ca
9a5aa31870 dev-manual: use "git", not "apmd", to explain checksum names
The apmd recipe is no longer appropriate to demonstrate the use of
SRC_URI checksum names as it has only a single SRC_URI URL, so pick a
more illuminating recipe.

(From yocto-docs rev: 7f391a0656442e7ee2f3dd48b848befb7f461aec)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 16:53:24 +01:00
rpjday@crashcourse.ca
43ad3f54ea dev-manual: use "strace" for PV example, not cdrtools
Section 3.3.5, "Fetching Code", uses the cdrtools recipe as an example
for showing the use of PV, but that's a bad example since the current
cdrtools recipe file contains:

  SRC_URI = " \
  ${SOURCEFORGE_MIRROR}/project/cdrtools/cdrtools-${REALPV}.tar.bz2 \
  ...

  PV = "3.01a31+really3.01"
  REALPV = "3.01"

which is not exactly the point the dev manual is trying to make, so
replace with simpler strace recipe.

(From yocto-docs rev: d865b0288a4162a8d4df9a2abde43875e3dc2ced)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 16:53:24 +01:00
Tim Orling
3b718dbdae brief-yoctoprojectqs: buildtools changes
Bump tar, Python versions and add new gcc requirement.

Update reference from 'required-git-tar-and-python-versions'
to 'required-git-tar-python-and-gcc-versions'

(From yocto-docs rev: ca6334c1653d5e2abfe77865391509a8cd516d88)

Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:25 +01:00
Tim Orling
edaad681fb dev-manual: buildtools versions and changes
Bump tar, Python versions and add new gcc requirement.

Update reference from 'required-git-tar-and-python-versions'
to 'required-git-tar-python-and-gcc-versions'

(From yocto-docs rev: 18b11662c7c9ab7828d2709eed4090116a751e14)

Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:25 +01:00
Tim Orling
07aaa69d57 ref-manual: add install-buildtools and -extended
Add instructions to use 'install-buildtools' and
'buildtools-extended-tarball'.

Add gcc 5.0 requirement and call out how to
use above to prepare host development system.

(From yocto-docs rev: c6dbd9bf6860ffea1bc025907343373439d91737)

Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:25 +01:00
Tim Orling
e75301e018 ref-manual: fix debian-8 system reqs
jessie-backports is no longer supported, so python3-git and
pylint3 are not installable via apt-get (or at least not
without disabling security checks by using archive.debian.org)

Add note to use pip3 to install instead.

(From yocto-docs rev: 19a02c5c6ef9a317c2339c2ec71200e51335e32f)

Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:25 +01:00
Tim Orling
2888172856 ref-manual: bump tar and python min versions
* tar min version is now 1.28
* python min version is now 3.5

(From yocto-docs rev: 96dfaee63f84c21fc2bf460ded642b853a5317cf)

Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:25 +01:00
Tim Orling
cdca9b23c9 ref-manual: split CentOS-7 and CentOS-8 reqs
CentOS-7 has different requirements than the much
newer CentOS-8. Add a section for CentOS-8 and
make the old section CentOS-7 specific.

NOTE: at the time this was written, the 'fop'
package is not yet available in epel-8. As
a Fedora packager, that will change.

(From yocto-docs rev: caf08811a23a29965ec915459019796a0c882d4d)

Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:25 +01:00
Tim Orling
cb6bb9d914 poky.ent: split centos-7 and centos-8
Update Centos-7 to require python3, not python.

CentOS-8 has different installation requirements than
either CentOS-7 or Fedora (although it is closer to
Fedora).

Allow for differentiation between CentOS versions.

(From yocto-docs rev: 615fc45108d10e842679b3d8a38b53074d3eed4b)

Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:25 +01:00
Tim Orling
85cc7cb4df poky.ent: recommend python36-pip for CentOS
'python3' in EPEL7 is now Python 3.6, so we
should be recommending python36-pip

Python 3.4 is EOL [1]

[1] https://www.python.org/downloads/release/python-3410/

(From yocto-docs rev: 817ca8adc91d9975b9ec57e7fead7fdff4001854)

Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:24 +01:00
akuster
24dab56884 documentaiton: Change author info
Update the author indo and use variables for author and email to make it
easier to change in future.

(From yocto-docs rev: 4fdf2a060705fa00b11b5a9d270f4ffa506c9927)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:24 +01:00
rpjday@crashcourse.ca
d4a3a121ed BSP Guide: numerous tweaks/grammar/wording/clarification
(From yocto-docs rev: 3a87e5900b603f124ce7f63fd072415762f63212)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:24 +01:00
rpjday@crashcourse.ca
284af91476 kernel-dev: fix explanation of KBUILD_DEFCONFIG
KBUILD_DEFCONFIG is meant to refer to an *in-tree* defconfig file, not
an external one.

(From yocto-docs rev: 34202eee3fc2bb4e0b92374822bff87fd3af1ebc)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:24 +01:00
rpjday@crashcourse.ca
0096b10efe correct mention of "postinst_intercept delay_to_first_boot"
Migration to YP 2.5 contains incorrect description of routine for
delaying to first boot.

(From yocto-docs rev: 08f71ec137822c0c19b56956d7045dfb73a544d7)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:24 +01:00
rpjday@crashcourse.ca
4f58e37e17 ref-manual: minor rewording/clarification in chapter 2
(From yocto-docs rev: a9a3248b12b85f3637ebe5eddd4b1a29268d5598)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:24 +01:00
rpjday@crashcourse.ca
77f6e7bb4e ref-manual: minor rewording in chapter 1
(From yocto-docs rev: 5582f01fc4774e7d21af24627bbd47a77463d272)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:24 +01:00
rpjday@crashcourse.ca
5486dd3680 ref-manual: update PROVIDES example, clarify use of "+="
Update the example used in explaining the PROVIDES variable to one
that actually exists, and point out that "+=" is unnecessary, a simple
assignment is sufficient.

(From yocto-docs rev: 80cd888ee81757bc5281f174b26974391ee45522)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:24 +01:00
rpjday@crashcourse.ca
f63d44ab32 ref-manual: various touchups, rewordings, corrections to Ch 5
Minor tweaks to chapter 5 of reference manual, including:

 - grammar
 - adding slashes to directory names for consistency
 - collapse trivial paras into one

(From yocto-docs rev: 96b75e723bff042183f70a858d09df4aad094578)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:24 +01:00
rpjday@crashcourse.ca
a5ac4b6fca use defined entity "YOCTO_DOCS_URL", not "YOCTO_HOME_URL"
Given the defined DocBook entity:

  <!ENTITY YOCTO_DOCS_URL "&YOCTO_HOME_URL;/docs">

replace numerous instances of the more verbose
"&YOCTO_HOME_URL;/documentation", which is a redirect, anyway.

rday

(From yocto-docs rev: 53fa17321624028b12d880bc4236fbef46675eb4)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:24 +01:00
rpjday@crashcourse.ca
b31daa130a dev-manual: minor tweaks, rewording, grammar for chapter 2
(From yocto-docs rev: 706386ac094479916e1cc482e56a6433caa85e1a)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:24 +01:00
rpjday@crashcourse.ca
fd54658d87 dev-manual: clarify PN usage in packagegroup files
Make it clear to the reader that they can use the much shorter form of
${PN} for the base packagegroup name, rather than typing it out in
full.

(From yocto-docs rev: 19915978c30bbf37b65d9887c78a23394779f079)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:24 +01:00
rpjday@crashcourse.ca
63efaa94c1 dev-manual: add missing check to yocto-check-layer section
Add explanation of missing checks performed by yocto-check-layer, and
fix one typo.

(From yocto-docs rev: 231bb92fa4a9c044894f845b8d6d0b9498abfc49)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:24 +01:00
rpjday@crashcourse.ca
5f6e055dc8 dev-manual: use actual machine override demonstration
Given that the section in question is describing how to configure
dependencies based on the machine type, it seems inappropriate to use
an example that depends on the choice of C library, so grab a snippet
from linux-yocto.inc to really drive the point home.

(From yocto-docs rev: 66bfec015f61a690f96cf8e28b80869c77327e6d)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:24 +01:00
rpjday@crashcourse.ca
0bcf88c375 dev-manual: explain LAYERDEPENDS with other layer.conf vars
(From yocto-docs rev: 2d56b38e1a1d4a89c0ed46af93791fe1fbdfecc9)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:24 +01:00
Alejandro Hernandez Samaniego
189791a43d dev-manual: Fix CROPS link
The link used in the documentation points to a file
that no longer exists on the crops repository.

Use the poky-container repo instead since it is more
accurate and updated

(From yocto-docs rev: 5d16ccecf0b198af0f78a4cce28532ab9dca739f)

Signed-off-by: Alejandro Hernandez Samaniego <alejandro@enedino.org>
Signed-off-by: Alejandro Hernandez Samaniego <alhe@linux.microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:25:52 +01:00
Alejandro Hernandez Samaniego
e2053e2547 overview-manual-yp-intro: Fix CROPS link
The link used in the documentation points to a file
that no longer exists on the crops repository.

Use the poky-container repo instead since it is more
accurate and updated.

(From yocto-docs rev: c5e21f5d18f4fc069ccc05cd82819eda291fcf9d)

Signed-off-by: Alejandro Hernandez Samaniego <alejandro@enedino.org>
Signed-off-by: Alejandro Hernandez Samaniego <alhe@linux.microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:25:52 +01:00
Alejandro Hernandez Samaniego
fb1c4df08b overview-manual-development-environment: Fix CROPS link
The link used in the documentation points to a file
that no longer exists on the crops repository.

Use the poky-container repo instead since it is more
accurate and updated.

(From yocto-docs rev: 98d2a2161a30d9080bc7dea8ae7964893563b1e2)

Signed-off-by: Alejandro Hernandez Samaniego <alejandro@enedino.org>
Signed-off-by: Alejandro Hernandez Samaniego <alhe@linux.microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:25:52 +01:00
Yeoh Ee Peng
c2ca25e51e dev-manual-common-tasks.xml: Replace "QemuTarget" with "qemu"
As the OEQA code revamp and code changes in testimage.bbclass,
testexport.bbclass, runtime/context.py and oeqa/runexported.py,
"QemuTarget" was obsolete and replaced by "qemu".
Replacing the refer of "QemuTarget" with "qemu".

(From yocto-docs rev: f89d18adb62bc864e7890a613ff860bd3e4279ed)

Signed-off-by: Yeoh Ee Peng <ee.peng.yeoh@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:25:52 +01:00
Yeoh Ee Peng
0b46a94528 ref-variables.xml: Replace "QemuTarget" with "qemu"
As the OEQA code revamp and code changes in testimage.bbclass,
testexport.bbclass, runtime/context.py and oeqa/runexported.py,
"QemuTarget" was obsolete and replaced by "qemu".
Replacing the refer of "QemuTarget" with "qemu".

(From yocto-docs rev: 87691219dfe312c0db0af1fa30cc3505298a27af)

Signed-off-by: Yeoh Ee Peng <ee.peng.yeoh@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:25:52 +01:00
Yeoh Ee Peng
004b87f476 dev-manual-common-tasks: Replace "SimpleRemoteTarget" with "simpleremote"
As the OEQA code revamp and code changes in testimage.bbclass,
testexport.bbclass, runtime/context.py and oeqa/runexported.py,
"SimpleRemoteTarget" was obsolete and replaced by "simpleremote".
Replacing the refer of "SimpleRemoteTarget" by "simpleremote".

(From yocto-docs rev: 41823811229754805c682ecec6903399bfe606fe)

Signed-off-by: Yeoh Ee Peng <ee.peng.yeoh@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:25:52 +01:00
Yeoh Ee Peng
48bbafde4e ref-variables.xml: Replace "SimpleRemoteTarget" with "simpleremote"
As the OEQA code revamp and code changes in testimage.bbclass,
testexport.bbclass, runtime/context.py and oeqa/runexported.py,
"SimpleRemoteTarget" was obsolete and replaced by "simpleremote".
Replacing the refer of "SimpleRemoteTarget" by "simpleremote".

(From yocto-docs rev: 1779a6d699ae7a6e51f8b92516eea948c1767400)

Signed-off-by: Yeoh Ee Peng <ee.peng.yeoh@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:25:52 +01:00
Alejandro Hernandez Samaniego
734f5cb5ba brief-yoctoprojectqs: Document the basics of WSL and create a link to the build host setup process
(From yocto-docs rev: 225e2aff28a4a68faf1bf1c702e7deacc9effbde)

Signed-off-by: Alejandro Hernandez Samaniego <alejandro@enedino.org>
Signed-off-by: Alejandro Hernandez Samaniego <alhe@linux.microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:25:52 +01:00
Alejandro Hernandez Samaniego
42daacc1ac overview-manual: Document the basics of WSL and create a link to the build host setup process
(From yocto-docs rev: 317059cbfcd8fdb342819b00f9f2836e44ce3d8b)

Signed-off-by: Alejandro Hernandez Samaniego <alejandro@enedino.org>
Signed-off-by: Alejandro Hernandez Samaniego <alhe@linux.microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:25:52 +01:00
Alejandro Hernandez Samaniego
57a3886757 dev-manual: Document the WSLv2 install process
(From yocto-docs rev: 65e3a1b3c82475f706418b8ec7d0e6bed34b382b)

Signed-off-by: Alejandro Hernandez Samaniego <alejandro@enedino.org>
Signed-off-by: Alejandro Hernandez Samaniego <alhe@linux.microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:25:52 +01:00
Alejandro Hernandez Samaniego
0894fd32bd ref-manual: Explain the project is not validated against WSL but people may still use it
(From yocto-docs rev: c55378d8a5597b3760dd9aae766af735a61a6158)

Signed-off-by: Alejandro Hernandez Samaniego <alejandro@enedino.org>
Signed-off-by: Alejandro Hernandez Samaniego <alhe@linux.microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:25:52 +01:00
akuster
a0a4f6bf89 yocto-docs: remove refrence to mpc8315e-rdb
(From yocto-docs rev: 8768196b4a313df794bf21937da4bf92de858463)

Signed-off-by: Armin Kuster <akuster808@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-03-24 22:49:31 +00:00
Goran Cengic
8afdc80989 documentation: add rpcgen tool to required packages
On recent distros the following error appears without rpcgen host tool:
  ERROR: The following required tools (as specified by HOSTTOOLS)
  appear to be unavailable in PATH, please install them in order to
  proceed:
    rpcgen

(From yocto-docs rev: 66a491e77e1b97a831515d4ac8e0245540d7242a)

Signed-off-by: Goran Cengic <cengic@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-03-21 22:31:00 +00:00
Robert P. J. Day
4cae3324bd manuals: Update YP manual notes with pointer to docs ML
Update the "Manual Notes" section of numerous YP manuals with a
reference to the recently-introduced YP documentation mailing list.

(From yocto-docs rev: a10fe36c864b8f1a71c6a8eb7e1f6a4eef2f5171)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-03-11 14:41:44 +00:00
Robert P. J. Day
fa6818b821 dev-manual: phrase should read "inherit packagegroup"
(From yocto-docs rev: 446204632ac9e8de3ce0b22df6fa2bb7605b9bce)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-03-11 14:41:44 +00:00
Khem Raj
1ca2992686 documentation: Remove python from UBUNTU_HOST_PACKAGES_ESSENTIAL
Ubuntu 20.04 doesn't have python package and therefore this list fails
to install, python3 is required anyway so removing python is perhaps ok

(From yocto-docs rev: a41567a4ee462c704a29ad5944a0c824d7eb840c)

Signed-off-by: Khem Raj <raj.khem@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-03-11 14:41:44 +00:00
Richard Purdie
c4bb662c58 dev-manual-common-tasks: Fix runall reference
[YOCTO #13715]

(From yocto-docs rev: 91fbf02ae126bcabfeb43525db620bbd36d5f583)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-03-11 14:41:44 +00:00
Mark Asselstine
cff8649018 manuals: Updates to reflect that MACHINE defaults to qemux86-64
meta-yocto commit 69ddecdb1516 [local.conf.sample: change default
MACHINE to qemux86-64] switched the default MACHINE from 'qemux86' to
'qemux86-64' but some documents which either explicitly mentioned the
default, or where this was implicit didn't receive an equivalent
update.

Where it made sense we continue this change in default to the docs. In
other places, such as the kernel-dev manual, we note the new default
and instruct the user how to switch back to 'qemux86'. Eventually we
should probably update the kernel-dev manual to use the default, but
for now the intention was to limit the impact of these changes.

Note that ext3 has also been replaced with ext4 for image generation,
so while we are modifying runqemu lines to qemux86-64 we also make the
change to reference ext4 such that the runqemu commands will function
properly.

(From yocto-docs rev: 8c1d8ab1170f47a2c2692beb903ab0b7c6835b7b)

Signed-off-by: Mark Asselstine <mark.asselstine@windriver.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-03-11 14:41:44 +00:00
Peter Kjellerstedt
0daf901b5b ref-manual: Add a tips on how to achieve whitelisting of licenses
It is sometimes more appropriate to define the licenses that are
allowed to be used rather than the ones that are not permitted. This
adds a tips on how this can be achieved by using AVAILABLE_LICENSES
and some Python set arithmetics.

(From yocto-docs rev: dd26d8a9f89402a9828bf02f2e65054d4c0f406f)

Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-03-11 14:41:44 +00:00
Peter Kjellerstedt
cc26e90a79 ref-manual: Add a variable description for AVAILABLE_LICENSES
(From yocto-docs rev: 275ea2bb30693315ebea659a82065b75066e13b6)

Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-03-11 14:41:44 +00:00
Peter Kjellerstedt
a4cc2e0d44 ref-manual: Update the documentation for USERADD_ERROR_DYNAMIC
* Update USERADD_ERROR_DYNAMIC[doc] and the first paragraph to match
  the definition in meta/conf/documentation.conf.
* Add a note explaining the differences in behavior when setting
  USERADD_ERROR_DYNAMIC to "warn" and "error" respectively.

[YOCTO #12932]

(From yocto-docs rev: 28cd546f3fe1eadd73ba71f9fe9a558538e69b0f)

Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-03-11 14:41:44 +00:00
Peter Kjellerstedt
91241f2b12 ref-manual: Add missing/remove extraneous quotes
(From yocto-docs rev: 542e362bf06c2d71ee6e30f5728ad5476f035c6e)

Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-03-11 14:41:44 +00:00
Peter Kjellerstedt
999c39e0e6 ref-manual: The sanity_info file has moved from build/conf to build/cache
(From yocto-docs rev: 813dd1a2ce48df08b92d821700380d5d231e6760)

Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-03-11 14:41:44 +00:00
Jefro
18b6b2ae81 Adding memoriam to scottrif
Added a few comment lines in Makefile to commemorate Scott's
contributions

(From yocto-docs rev: 07c88e2724a223b26694c98c0e976d735aee00e6)

Signed-off-by: Jefro <jefro@jefro.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-01-31 08:03:08 +00:00
Richard Purdie
260a215171 documentation: Remove accidentally added files
(From yocto-docs rev: 35f2ae3795a09bdee6d5dd0217f1f5091d8f1ecb)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-01-07 12:22:44 +00:00
Scott Rifenbark
7e7b066085 YP 3.1 Docs: Updated Manual revision tables.
Scrubbed so subsequent releases are relevant to the
initial release only.

(From yocto-docs rev: 7bb2c4f851aa968eb05b11c5471b81962f268eba)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-12-16 23:32:33 +00:00
Scott Rifenbark
98e34b71ef poky.ent: Updated variables for YP 3.1
(From yocto-docs rev: 28606ba4bd9994b854ebc790810dfdfb06538c55)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-12-16 23:32:33 +00:00
Scott Rifenbark
292b0cc224 YP Documentation: Set up for YP 3.1 release
* Updates to poky.ent
* Updates to mega-manual.sed
* Updates to all <manual>.xml files for date

(From yocto-docs rev: 5f752ef0193cb60cd5d46a63e99ffcd02107e0c2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-12-09 12:02:54 +00:00
Scott Rifenbark
a1bc1ccf42 dev-manual: Removed duplicate paragraph for selecting init manager.
(From yocto-docs rev: d22e9762cc26b5f5454b446022ee308ffe90e1ef)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-12-09 12:02:54 +00:00
Scott Rifenbark
9383489102 ref-manual: Removed blank lines from 3.0 migratrion section.
(From yocto-docs rev: a3c4701e0b6fc90aaa7138c1fd772e0d8ad7e3a6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-11-10 14:06:31 +00:00
Scott Rifenbark
4426cb3c47 mega-manual: Updated mega-manual Bitbake manual search path
using ../.. instead of ../../..

Fixes [YOCTO #13553]

(From yocto-docs rev: 6611a4726167e8597417e132661a29ec411266cc)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-11-10 14:06:31 +00:00
Scott Rifenbark
370e4b223d ref-manual: Completed the 3.0 migration section.
(From yocto-docs rev: 1f996ce595b91e2dba55bdeeb2a558eb8a16c195)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-11-10 14:06:31 +00:00
Scott Rifenbark
ff0db7b88e ref-manual, dev-manual: Added CMake toolchain files.
Fixes [YOCTO #12760]

Updated the cmake.bbclass description to tell what directory
to insall custom CMake toolchain files into.  Also, updated
the two areas in the "Writing a New Recipe" section that
mention CMake.  Placed a couple notes there concerning the
same directory stuff.

(From yocto-docs rev: a65cd2c4c062d4ae388191b9d6708b4fadffaa3f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-23 17:15:53 +01:00
Scott Rifenbark
20d648416b ref-manual: Updated the BUSYBOX_SPLIT_SUID variable.
Fixes [YOCTO #13596]

(From yocto-docs rev: 015991b26ed091385cfb94f13e00c6a964c20160)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-23 17:15:53 +01:00
Scott Rifenbark
495bb1e329 ref-manual, dev-manual: Clean up of a commit
Alejandro Enedino Hernandez Samaniego <aehs29@gmail.com>
commited a change to these manuals (see
9e79e96cad66316c1b4ee608723edfa763f0f9ef) and did not
use YP documentation standards for the content.  I cleaned
up the text and tabbing.

(From yocto-docs rev: 9c95799322e1830a5faae0980384ab10b6504007)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-23 17:15:53 +01:00
Scott Rifenbark
b70a4d8d5d ref-manual: Removed deprecated link to ref-classes-bluetooth
This was in a moving to YP version 1.8 migration section.

(From yocto-docs rev: b87f0882c39524747004fafc4d1caf58b3344c3a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-23 17:15:53 +01:00
Scott Rifenbark
3eb09fd737 documenation: Changed "2.8" to "3.0".
I was using "2.8" throughout the manual set instead
of "3.0".  Updated all aspects to "3.0".

(From yocto-docs rev: db19937e98c59d4d2a9ce89877be3c8e0b05991a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-23 17:15:53 +01:00
Scott Rifenbark
c1fc3ed407 ref-manual: 2nd pass 3.0 migration
Turned "2.8" into "3.0".  Nobody told me about skipping
2.8 and 2.9.

(From yocto-docs rev: 13819f0651c48adae9d1a8d6d19341ba5ee44978)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-23 17:15:52 +01:00
Scott Rifenbark
9db609edf7 dev-manual: Added info to "Selecting an Initialization Manager"
(From yocto-docs rev: c402ebcb51b6400d79c62ff44aeae57db982565e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-23 17:15:52 +01:00
Scott Rifenbark
ca2dc29326 poky.ent: Updated the release date to October 2019
(From yocto-docs rev: 21042fd8ad463c996e554f52359a599ee7d35c12)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-23 17:15:52 +01:00
Scott Rifenbark
269f3c8873 ref-manual: First pass of 2.8 migration changes (WIP)
(From yocto-docs rev: 2c0f6cd921132caa4f49c34ac592db68be27761a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-23 17:15:52 +01:00
Ross Burton
52a625582e kernel-dev: don't use _append +=
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-15 14:17:58 +01:00
Ross Burton
f574abdf75 ref-system-requirements: update support distribution list
Add Fedora 30 and Ubuntu 19.04.

Swap openSUSE 42.3 for Leap 15.1.

Remove huge comment of old distributions.

(From yocto-docs rev: 8fe3040a68c0aee44c4a6dcd5088b61d6908b0f9)

Signed-off-by: Ross Burton <ross.burton@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-09 14:05:24 +01:00
Alejandro Enedino Hernandez Samaniego
677bfa6a69 documentation: Update multiconfig syntax and explanation on BBMULTICONFIG
The syntax to use multiconfig builds changed from multiconfig:foo:target
to mc:foo:target.

Clarify that BBMULTICONFIG defines additional configurations along with
the one coming from local.conf.

Fix these changes on both the dev manual and the reference manual.

(From yocto-docs rev: 9e79e96cad66316c1b4ee608723edfa763f0f9ef)

Signed-off-by: Alejandro Enedino Hernandez Samaniego <aehs29@gmail.com>
Signed-off-by: Ross Burton <ross.burton@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-09 14:01:01 +01:00
Adrian Bunk
3b87508a9a ref-manual: Remove documentation for the removed gnome class
When removed all it did was
  inherit gnomebase gtk-icon-cache gconf mime
which would also be the most trivial replacement.

Most of the time not all of these classes were needed,
and it is recommended to use only the ones actually required.

(From yocto-docs rev: a0a3a8318a1488ad2fb00b29f1cf26a9d6701be2)

Signed-off-by: Adrian Bunk <bunk@stusta.de>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-09-10 11:21:55 +01:00
Ross Burton
320fd9e28f ref-system-requirements: add Debian 10 to supported distribution list
Debian 10 is a supported distribution now, so add it to the documentation.

(From yocto-docs rev: 77ff109cf7dbe1858e9959c4b9f1225d0a1c5e32)

Signed-off-by: Ross Burton <ross.burton@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-09-10 11:21:55 +01:00
Adrian Bunk
b5b5f90a79 ref-manual: Remove documentation for the removed bluez5 distro feature
bluez4 was removed even from meta-oe 2 years ago,
which made made the bluez5 feature for selecting between
bluez4 and bluez5 mandatory for using the bluetooth feature.

The backfilled bluez5 feature has been removed,
including the bluetooth class that helped recipes
for selecting between bluez4/bluez5.
Recipes can replace ${BLUEZ} with bluez5.

(From yocto-docs rev: 025e2b5797b987b0260d7410e2e6d7283f5a7e91)

Signed-off-by: Adrian Bunk <bunk@stusta.de>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-09-10 11:21:55 +01:00
Scott Rifenbark
196561b696 ref-manual: sync list of image types with source
(From yocto-docs rev: fc2817a4ca75efcb556c84ba5c6edcb4d703a78f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-09-06 11:59:45 +01:00
Scott Rifenbark
36500d9d87 poky-end: Added "pylint3" package to Ubuntu essentials.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-09-06 11:59:45 +01:00
Adrian Bunk
7b989f563f Update to KERNEL_DEVICETREE variable.
Corrected the requirements for the KERNEL_DEVCIETREE
variable example.

(From yocto-docs rev: 0502910c81f4d669457155ed5f52d5fa775d8d6d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-09-06 11:59:45 +01:00
Scott Rifenbark
7f04f85f71 dev-manual: Updated "Creating a Team Development Environment"
This section needed the wording updated.

(From yocto-docs rev: dd9e09273e9e5d5b6b43bf508f50d4d57e0dc569)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-09-06 11:59:45 +01:00
Scott Rifenbark
01a4b3f0a0 ref-manual: Updates to "Building Your Recipe"
(From yocto-docs rev: 6aa1fe818c284c1d740ce8063d58c664e73d380d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-09-06 11:59:45 +01:00
Scott Rifenbark
cfa0507589 ref-manual: Updated the "AS" variable
(From yocto-docs rev: ebd659999da3c465e1dbe3fb07d5eedbb6ff4c8f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-09-06 11:59:45 +01:00
Scott Rifenbark
1370f3ad2e ref-manual: Removed "python2" mention in example.
We are not using Python2.  I removed this instance in the ref
manual. The variable "PYTHON_PN" referenced Python 2.  It no
longer does.

(From yocto-docs rev: bd2ed0c640e12e8010ebff0aaba77e8fe367d63e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-07-18 12:16:53 +01:00
Scott Rifenbark
1cf94948b7 ref-manual: Fixed typo for BBMULTICONFIG variable.
There was a typo in the BBMULTICONFIG variable description.
It appeared as "BBMULTIFONFIG". I fixed it.

(From yocto-docs rev: c53b1bb6e588f9ee87cb8ab85fc8c3985257a37a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-07-18 12:16:53 +01:00
Scott Rifenbark
bcd50509bf dev-manual: Provided proper link title
In the "Enabling GObject Introspection Support" section, a link
existed to the "Known Issues" section further down in the
chapter.  The target of the link was missing and appeared as the
placeholder "xxx".  I put in the proper link.

(From yocto-docs rev: 8d0d1b2104f08e888075bc0ae0bed4f0ec2f4ea6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-07-18 12:16:53 +01:00
Scott Rifenbark
25efbee1d7 sdk-manual: Updated devtool to talk about oe-local-files.
Fixes YOCTO #13079

Bug is about making sure the section on the devtool command
talks about oe-local-files.  Two devtool commands (modify
and upgrade) needed to mention the role of the oe-local-files
area and how it is used during these commands.  I updated the
appropriate sections:

 * Use devtool modify to Modify the Source of an Existing Component
 * Use devtool upgrade to Create a Version of the Recipe that
   Supports a Newer Version of the Software.

(From yocto-docs rev: 70ed68eca6dcb5b1f1b5638fd27a7b513b65661e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-07-18 12:16:53 +01:00
Scott Rifenbark
f3c76f8fd6 overview-manual: Fixed manual history table
Missing information for some of the releases put back in.

(From yocto-docs rev: f4c09ab9eda925c16946d9d6cf58d1e40d8f6a07)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-07-18 12:16:53 +01:00
Scott Rifenbark
111b7173fe dev-manual: Fixed grammar issue.
Fixed in "Selecting an Initialization Manager" section.
Extraneous word needed removed.

(From yocto-docs rev: ab97d36299a7a648bc3f3325175d8ab633ad2d1a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18 11:29:23 +01:00
Scott Rifenbark
ab69e1917f overview-manual: Updated SCM section
Fixes [YOCTO #10098]

I updated the "Source Control Managers (Optional)" section
to reference the "Fetchers" section in the BB manuual.

(From yocto-docs rev: 0c014fba509d3ec28236e63a7bd2355b447c4acf)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18 11:29:23 +01:00
Scott Rifenbark
b0b59bd2b8 ref-manual: Updated "npm.bbclass" section.
I provided a general link to the wiki on npm software.
Also, updated the section to point to the new section on how to
create NPM packages, which is in the dev-manual.

(From yocto-docs rev: 03fd635d06d64a53ad00196919350a45942731ce)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18 11:29:23 +01:00
Scott Rifenbark
4f44204d1a dev-manual: Updated the "Working with Packages" list
I added the "Creating node package manager (NPM) packages
section link to the list.  Also, made some edits to make
the capitalization consistent in the list items.

(From yocto-docs rev: d3e345cd3f44e9588c5fe8f0560e1859df0ff496)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18 11:29:23 +01:00
Scott Rifenbark
688fee4596 Makefile: Updated to support new NPM package creation section
The newly created section on how to create NPM packages
required a figure.  I added the figure to both the dev-manual
and mega-manual tarballs creation areas.

(From yocto-docs rev: 5109274d107b6d3ae6be3f71a20379cb6abb39d6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18 11:29:23 +01:00
Scott Rifenbark
c19e706b2c dev-manual: Added new section for creating NPM packages
Fixes [YOCTO #10098]

This is a new section in the development tasks manual that describes
how to create Node Package Manager (NPM) packages.  I put the
section in the "Working with Packages" section.

(From yocto-docs rev: d7acd9f27418d414854d25bb27842407edfe7dda)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18 11:29:23 +01:00
Scott Rifenbark
bbe3bf4bfe ref-manual: Grammar correction
I left out the word "not" in a key sentence in the new
"Checking on the Upgrade Status of a Recipe" section.

Little words can make big differences.

(From yocto-docs rev: 46a524a0d6c9e2ed6428039a4454e384a6ef648d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07 13:57:41 +01:00
Scott Rifenbark
99f9a53b6b ref-manual: Updates to check-recipe-upgrade devtool command
I updated the section to include more detail on what the user
sees in the returned table.

(From yocto-docs rev: 671279548dde7f356888ba1ad1551b8bb1f70a65)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07 13:57:41 +01:00
Scott Rifenbark
bbdf0453d0 ref-manual: do_checkpkg - added link to checking upgrade status
I show the "devtool check-upgrade-status" command as part of
the "do_checkpkg" task section.  I added a cross-reference
link to the "Checking on the Upgrade Status of a Recipe"
section in the ref-manual.

(From yocto-docs rev: 034054f431cc9f0e61c8e156eed66bdf6e1198a1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07 13:57:41 +01:00
Scott Rifenbark
40233c62f8 dev-manual: Added check-upgrade-status blurb to upgrading recipes
The section "Upgrading Recipes" covers several ways of
upgrading a recipe.  I added some stuff in the introductory
area that mentions the fact a user might want to check
the upgrade status of a recipe first.

(From yocto-docs rev: bd2fd8d0a91b64455c282ebf4974e40874274f46)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07 13:57:41 +01:00
Scott Rifenbark
e6b1e54d85 ref-manual: New section "Checking Upgrade Status of a Recipe"
I added a new section showcasing the "devtool check-upgrade-status"
command.

Also, added a note in the "Upgrading a Recipe" section" to tell
the reader they might want to check on a recipe's upgrade
status before upgrading a recipe.

(From yocto-docs rev: 974f63fe8836fccd51f12b511c23644235cbd4b4)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07 13:57:41 +01:00
Scott Rifenbark
50d2fb44a5 ref-manual: Udated devtool help output examples.
Specifically missing was the "devtool check-upgrade-status"
command.

(From yocto-docs rev: beaa40e8d1037f237ab588ec6ce256b8c3a18543)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07 13:57:41 +01:00
Scott Rifenbark
890a993be1 ref-manual: Removed "distutils-tools" class.
This class was removed for 2.7 and I took the reference section
out of the class area.

(From yocto-docs rev: daf786bebb0286d2ced46c97957d80a94c921c56)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07 13:57:41 +01:00
Scott Rifenbark
a4782409c4 ref-manual: Removed bugzilla.bbclass
The migration section noted this class as becoming obsolete.
I removed it from the class reference section.

(From yocto-docs rev: 63128888242493fb5671f11a2e5e470f2da6b22a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07 13:57:41 +01:00
Scott Rifenbark
f21fc9d1be dev-manual, ref-manual: removed "distrodata" class
Ousted these since it was noted in the migration section that
the class had been removed.  Modified all references to the
removed class as needed.

(From yocto-docs rev: 7000acc76da6b7ee850b799347ab9083663c7e6a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07 13:57:41 +01:00
Scott Rifenbark
d4fc8cf7ae ref-manual: Updated "do_fetch" to have a link to "Fetchers"
Fixes [YOCTO #10098]

This task needed to cross-reference the "Fetchers" section,
which is in the BitBake User Manual.

(From yocto-docs rev: c8862f4c8cc43777acead0e93fc728f2e8be4641)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07 13:57:41 +01:00
Scott Rifenbark
d52682c054 sdk-manual: Added link to BB manual fetcher section.
In the "Use devtool upgrade to Create a Version of the Recipe
that Supports a Newer Version of the Software" section, we
reference "fetchers" but do not link to the section on them
in the BB manual.  I added a link.

(From yocto-docs rev: 633ac78daa2ab3bdde17ecb1a203f6addd6ee4af)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07 13:57:41 +01:00
Adrian Bunk
39f30789e2 ref-manual: Remove irda feature
IrDA support was removed in upstream kernel 4.17,
and irda-utils as well as the feature are now also removed.

(From yocto-docs rev: 5650b3c733310b4d478440449d427de417946c81)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07 13:57:41 +01:00
Scott Rifenbark
a015ed7704 ref-manual: Added "npm" information to the SRC_URI variable.
(From yocto-docs rev: 644cf94333ef289e9d0719f46b76f712f4807573)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-15 21:54:15 +01:00
Scott Rifenbark
820ebc43d8 overview-manual: Updated SMC section to link to fetchers
Fixes [YOCTO #10098]

I did some re-writing here and also linked over to the
"Fetchers" section, which is in the BitBake User Manual.

(From yocto-docs rev: a2ba04bcf13dd1c68cba5a79ae9e7d4c8fbcdf59)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-15 21:54:15 +01:00
Scott Rifenbark
00ff69a5bb dev-manual: Added cross-link to "Fetchers" section in BB manual.
Fixes [YOCTO #10098]

Inside the "Fetching Code" section we mention fetchers but have
no links for more information to the "Fetchers" section in the
BibBake User Manual.  I have added a link.

(From yocto-docs rev: 5224bb7b7a3c0f081b066a45865fd326aa068fc9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-12 09:14:03 +01:00
Scott Rifenbark
cfc0211165 bsp-guide: More corrections to the BSP Kernel Recipe example
After reading this over, I needed to explicitly state the
*.bb and *.bbappend file names.  It is clear now.

(From yocto-docs rev: 901b76d9f94c33da15382068dc933d765cddade5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-12 09:14:03 +01:00
Scott Rifenbark
10edc0b04e ref-manual: Updated PREFERRED_VERSION variable to use 5.0
I changed the PREFERRED_VERSION_linux-yocto example to use
the 5.0 linux-yocto kernel rather than the 4.12 version.

(From yocto-docs rev: 334554dd87f5372066d55246384ed5205aaf1f86)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-12 09:14:03 +01:00
Scott Rifenbark
693cbd17df bsp-guide: Updated the BSP kernel recipe example.
There were some issues with this.  The example stated using an
append file and the file was actually named as a regular
recipe file.  I fixed that.  Also, I updated the
PREFERRED_VERSION_linux-yocto variable from "4.12" to "5.0"
to be more up-to-date.

(From yocto-docs rev: 933a668ef73b417587b4a8091b834db220611bd6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-12 09:14:03 +01:00
Scott Rifenbark
59f95aaae4 documentation: Cleaned up "plug-in"/"plugin" terminology.
The YP manual set was using the plugin term inconsistently.
It was appearing as "plugin" as well as "plug-in".  The
plugins in the project are all named without a hyphen.
The term itself is either/or according to Google.  I have
changed all references to plugin so that they do not use
a hyphen.

(From yocto-docs rev: 715bb58e2347c5e37a49da7d9e3e230503672337)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:42 +01:00
Scott Rifenbark
2a540a95a5 bsp-guide: Updated the "beaglebone-yocto.conf" example.
This listing had gone stale.  I updated the actual listing to match
what is in poky repository and adjusted the various variable
explanations affected.

(From yocto-docs rev: 44ccb6ea7301ffa43c89f7a4f28265ea28725f99)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
bfe52a3d6c ref-manual: Updated the "Container Layer" term.
I removed the incorrect "meta-intel" layer for the example
and replaced it with the better "meta-openembedded" layer.

Reported by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: eed35c97aa53efdcdb9a270555774a7c3a0e3b69)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
69aa458db2 bsp-guide: Removed inaccurate "container layer" references.
I left only the single mention of "container layers" and changed
the example from "meta-intel" to OpenEmbedded's meta-openembedded
layer.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 8aa4de2be19c001f19cc540e2f7b33ca71f6be60)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
3693f075c4 documentation: Prepared for 2.8 release
poky.ent - variables all set up for 2.8
mega-manual.sed - "2.7" replaced with "2.8"
<folder>.xml - manual revision history tables updated.

(From yocto-docs rev: 6092a9282cbd397a2f64ca74361f862ea76b0e28)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
aa90b8ca24 ref-manual: Review comments applied to 2.7 migration section.
(From yocto-docs rev: 81ced4c68631d4d63efec206e5453b00d8fcc786)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
95f7ae5897 poky.ent: changed 2.7 release variable date to "May 2019"
(From yocto-docs rev: 0c94c5c2c4300a9b91ab2be866d8781a79d2f62d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
69684c489e ref-manual: Added Fedora 29 to the supported distros list.
(From yocto-docs rev: 196bc35669e81b269d4576f552bdecc191bbc80a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
d38a253147 ref-manual: Added "License Value Corrections to migration.
(From yocto-docs rev: 398a60005b9ce63e6ee141dfb8a71e8ae2bf2d86)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
24c80ee695 ref-manual: Added Eclipse removal for migration section.
(From yocto-docs rev: 06409e5fa0080f76f68d9f98b3c9f5a4edfcc948)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
932b8ae307 ref-manual: Inserted Migration 2.7 section.
(From yocto-docs rev: 238ddd62995420741c2b97ccfa7d2c533b72837c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
f60698d54b dev-manual: Added reasoning blurb to "Viewing Variables" section.
I put a new introductory paragraph in the "Viewing Variables"
section that alludes to why you might want to see variables.
Also, I linked to the section "Modifying Variable Values" in
the BB manual.

(From yocto-docs rev: 6e18524ba62d2ff1231184467b0dd24dab33cfe6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
237b225552 dev-manual; brief-yoctoprojectqs: Updated checkout branch example
Added the "yocto-2.6.2" tag to the example output since that
will be part of the overal list when 2.7 releases.

(From yocto-docs rev: 4863284811ad459cb0193528d5686a1ec008bb3e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
dbe100d6bb sdk-manual: Removed all references to Eclipse
Took care of links as well.

(From yocto-docs rev: a338dc13ebbcdc77fb16e36f12eb5f0e1e05187f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
c5bb614ca7 sdk-manual: Removed all references to Eclipse
One Neon appendix completely removed.  One other chapter
removed that held the latest version of Eclipse use
removed.  A figure was also removed.

(From yocto-docs rev: 03524fc363f9232a2ed45d10688ddeb0439b0917)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
75cf92d446 ref-manual: Removed all references to Eclipse
Links updated as needed.

(From yocto-docs rev: acd5a75314b023f613be24b7512f991f8455e325)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
7625e3cffe profile-manual: Removed all references to Eclipse
One figure was removed and files modified.

(From yocto-docs rev: f5d7024c3c38bc7737894a5ad4b750d4d633f173)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
f2c6d6c84b overview-manual: Removed all references to Eclipse
I also fixed all linking as needed.

(From yocto-docs rev: f987bc2846a2356a58934164652bb1dc59623b3b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
9879f0c01d dev-manual: Removed all references to Eclipse.
I also fixed all linking as needed.

(From yocto-docs rev: c8d10a924a3a4ae76e8fc26ebcba52ea04f2f267)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
c149239f08 mega-manual: Removed the Eclipse chapters
Two chapters formerly in the sdk-manual were included when
the mega-manual makes.  These chapters are no longer
needed.

(From yocto-docs rev: a4e76a30baba5ab1d8f9783bb2a329d136600126)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
9ab63d3c9d poky.ent: Removed Eclipse related variables.
(From yocto-docs rev: dc8942cf48cd322c3f125b3ec14817c43ca0322a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
aed303d415 mega-manual, overview-manual: Added updated index releases figure
The index-downloads.png file changes due to "eclipse" no
longer being there.  Both the overview-manual and the
mega-manual figures folders hold this figure.

(From yocto-docs rev: ef7b8dd8d636ef0ad563d1fe1ef44227f5f89fbc)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
5bee5d3677 mega-manual: Removed two Eclipse figures from tarball list
Eclipse is no longer supported.  We do not need thes figures
as they would no longer exist.

(From yocto-docs rev: efcfb5a62fcacdc606b8485da809bdf6aa19a5f3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
c18fe9eb64 Documentation: Removed customization.xsl files for Eclipse
The help files for YP manuals used in the Eclipse application
are no longer supported.  I removed the individual
*-customization.xsl files for the individual YP manuals.

(From yocto-docs rev: 8c19244298b2c95ac92a398a5b6d3aca788f075e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:40 +01:00
Scott Rifenbark
323101caf8 Makefile: Removed Eclipse support
Updated the file so that Eclipse help for YP manuals is
not generated.  Updated comments to remove examples of
Eclipse.

(From yocto-docs rev: db62b107e82a9d6fad619b03d57e807b3a617afd)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:40 +01:00
Scott Rifenbark
59b832f360 overview-manual: Fixed broken link to pseudo.
Link has disappeared.  I am no longer using it and am using
the article to "Why Fakeroot" to cover both Fakeroot and
Pseudo "extra information" stuff.

(From yocto-docs rev: 679c6a48a8e4bcc51bb8e97f2ba80123bdba6a5c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-04-09 22:16:06 +01:00
Gianfranco Costamagna
f9d789820b kernel-dev, sdk-manual: Unified question spacing
unify the spacing for questions in various places
e.g. before the [Y/n] there should be a space, and before
"?" there should be none. Unify the questions where the
system expect an answer from the end user

(From yocto-docs rev: 0643b2e22273a798b96f126931885efd733e5f89)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-04-09 22:16:06 +01:00
Scott Rifenbark
5555841e5e ref-manual: Updated BB_GENERATE_MIRROR_TARBALLS
Updated the description to tell the user they can safely
clean up the DL_DIR after creating tarballs of the source
files from downloaded repos.

(From yocto-docs rev: 6aff69632ea3102b6389ea510e1e3fa5bf1c2123)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-04-09 22:16:06 +01:00
Scott Rifenbark
35742c10f5 ref-manual: Removed DISK_DESCRIPTION variable from glossary
(From yocto-docs rev: 0bc99a673376e70279a353f654287068c59a0b03)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-03-26 15:38:56 +00:00
Scott Rifenbark
8ded31e052 dev-manual: Clean up for "Replicating Build Offline"
Some final corrections for the section on how to replicate
a build offline.

(From yocto-docs rev: 3b4ffa131684f824b7bc6c37ddfd02bb9b17b08c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-03-19 23:54:02 +00:00
Scott Rifenbark
ddc9d240f4 dev-manual: Added note about AUTOREV for replicating build
Feedback from Paul.

(From yocto-docs rev: ea118a9d6fa671de10b9aa8413c7d29951593ec3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-03-19 23:54:02 +00:00
Scott Rifenbark
95d6ad04fb dev-manual: Updates to "Replicating Your Build Offline"
I updated the section with some feedback from Richard.  This
version is much clearer and brings the concepts out a lot
better.

(From yocto-docs rev: 9790482b9937308bee6aa00a892f50d026187342)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-03-19 23:54:02 +00:00
Scott Rifenbark
f0d225fcd5 dev-manual: Added section on offline "snapshot" build.
This is a new section in the tasks chapter of the
dev-manual titled "Replicating a Build Offline".
It is in response to multiple hits in the
yocto@yoctoproject.org list asking how to do something
like this.

(From yocto-docs rev: 61b091be49517548e639808f6b6de4bf07e2a300)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-03-19 23:54:02 +00:00
Filip Jareš
28f9cf565a ref-manual: Fixed SRC_URI cut-and-paste error.
The update fixes a copy-paste-and-forget-to-update-everything error
in the documentation of the `SRC_URI` entry in the Reference Manual.
The `maxdate` paragraph just repeated what is there for the
neighboring `mindate` paragraph which was incorrect.

(From yocto-docs rev: bbeb096222d42a31adcb358a85f8fe6c4120416a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-03-19 23:54:02 +00:00
Scott Rifenbark
e63d516db3 YP Documentation: Updated host package lists
Changes to the lists resulted in the testing and graphics &
Eclipse Plug-in lists going away.  Also, I added several packages
based on some testing requirements to the "Essentials" list.

(From yocto-docs rev: cbc9a595bef3dd80f5eef1376e466627248f9fda)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-03-19 23:54:02 +00:00
Scott Rifenbark
5c2dca7e75 ref-manual: Added INIHIBIT_SYSROOT_STRIP variable desc.
(From yocto-docs rev: 867c5affcecff77ec4b36f026baba80a6bf4fe62)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-03-19 23:54:02 +00:00
Scott Rifenbark
8c7ec72e6d ref-manual, poky.ent: Updated essential host packages
Fixes [YOCTO #13196]

The set of host packages for the testing has been merged into
the essential set of packages for all supported distros.  I
updated the variables defined in "poky.ent" so that these
packages are now part of the essentials.  I also removed the
section on the required packages for testing.

(From yocto-docs rev: 9b19661d21a14966eac162ee063fca46d6403323)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-03-19 23:54:02 +00:00
Scott Rifenbark
5fa73c1392 ref-manual: Removed DISTRO_FEATURES_LIBC variable
Took this out of the glossary.  After eglibc was merged
into glibc, Kconfig support was also dropped so
these libc features therefore are not effective anymore
and can be removed.

(From yocto-docs rev: cfdd02864f004fc48b0353ec0f007ca24b06d29e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-03-19 23:54:02 +00:00
Scott Rifenbark
c078994c2f overview-manual, mega-manual: Updated Package Feeds diagram
The diagram had a typo in it ".ipd" rather than ".ipk".
Fixed and dropped in the figures folder for each manual.

(From yocto-docs rev: d39d196713a68df8d298f6ed0f40899bc148a323)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-25 10:44:07 +00:00
Scott Rifenbark
cd7a4e95cf kernel-dev: Updated section on running menuconfig
Fixes [YOCTO #13146]

I added some information to the "Using menuconfig" section to
indicate two host packages that must be installed in order for
menuconfig to run.

(From yocto-docs rev: 4f5b12ebe8f8c0ab23001b8fc770295dc585429c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-25 10:44:07 +00:00
Daniel Ammann
b421a21f2f ref-manual: Typo found and fixed.
(From yocto-docs rev: 8a64478540dcaad5e79d5ef494f9086a3c8a50a1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-25 10:44:07 +00:00
Scott Rifenbark
cb8be98355 dev-manual: Updated clone and checkout example.
Needed to have a predictive number of tags and branches
in the example commands that assume a released 2.7 version.

(From yocto-docs rev: b9f302cf819dbe759b560f4586edaedfae13e3d9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-25 10:44:07 +00:00
Scott Rifenbark
8e5ee522b7 brief-yoctoprojectqs: Updated tag list in example.
(From yocto-docs rev: 93fabeb457ba98dc3a328a5951b82f5419276c8f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-25 10:44:07 +00:00
Scott Rifenbark
0867bde9a2 ref-manual: Review edits to FILESOVERRIDES variable.
Fixes [YOCTO #13112]

Added a reference in the FILESOVERRIDES variable description
to the FILESPATH description to see an example of how automatic
overrides work.

(From yocto-docs rev: e78fc3468de3d9b9935f0e4f4aa4117b6805e631)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-25 10:44:07 +00:00
Scott Rifenbark
554379870f ref-manual: Updates to FILESPATH and FILESOVERRIDES.
Fixes [YOCTO #13112]

Did some paragraph re-ordering based on reviewer feedback.
Also, added a bit in the FILESOVERRIDES variable description
about out it uses overrides to help with automatic overriding
of the FILESPATH variable.  Added some better links into the
BitBake User Manual as well.

(From yocto-docs rev: 6ad5c6f030501cda9bc8ea648d9d7c0e991f55cf)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-16 08:19:55 +00:00
Scott Rifenbark
f2c0bba7e7 dev-manual: Grammar fix.
(From yocto-docs rev: 49e54aee94bc0972142efd1ba72eb1d9431c86c9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-12 21:49:01 +00:00
Brian Silverman
316f17fb47 overview-manual: Fixed typo.
"eSDSK" -> "eSDK"

(From yocto-docs rev: 5ececa4362e0400e01327dbe4ce25202f2c392ce)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-12 21:49:01 +00:00
Scott Rifenbark
d36b193caa ref-manual: Fixed literal formatting in INC_PR variable.
No indentation was being used for the example.

(From yocto-docs rev: e5d13181546d19772fede972b20518103d897eaa)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-12 21:49:01 +00:00
Joshua Watt
4d7db0fb1c ref-manual: Update default value for PACKAGE_DEBUG_SPLIT_STYLE
The new default is "debug-with-srcpkg"

(From yocto-docs rev: b427e7c2d9f6efca7e0867cc8e508d4e941c5a09)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-12 21:49:00 +00:00
Scott Rifenbark
d31fcfa652 ref-manual: Updated list of supported distros.
(From yocto-docs rev: 95eadbcc69b83ef92f28098058d62c596d4936cc)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-12 21:49:00 +00:00
Peter Kjellerstedt
676705765a ref-manual: Update to SDK_VERSION variable.
Updated the definition to match that of poky.conf.

(From yocto-docs rev: 09c73c227c6949ed3f1287ce063aa96967ed2fda)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-01-21 16:11:43 +00:00
Scott Rifenbark
4211a74978 dev-manual: Added some clarification for nographic qemu option.
(From yocto-docs rev: ff3d2ed0878d511f48007f5df468ae04e95109eb)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-01-16 15:35:57 +00:00
André Draszik
ee30b9a77d dev-manual: Remove True option to getVar calls
getVar() has been defaulting to expanding by default for
a long time (2016), thus remove the True option from
getVar() examples with a regex search and replace.

Search & replace made using the following command:
    sed -e 's|\(d\.getVar \?\)( \?\([^,()]*\), \?True)|\1(\2)|g' \
        -i $(git grep -E 'getVar ?\( ?([^,()]*), ?True\)' \
             | cut -d':' -f1 \
             | sort -u)

Note that there are are several other examples of getVar()
usage which already don't explicitly add the True option,
this patch just align some stray remainders.

(From yocto-docs rev: 9824280085c4164c614c5ef2bc1e69ffac1732dd)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-01-16 15:35:57 +00:00
Scott Rifenbark
dc24d63938 brief-yoctoprojectqs, dev-manual: Update tag checkout examples
Turns out I had some hard-coded stuff in these examples.
Furthermore, I did not have good enough detail in the
brief-yoctoprojectqs manual.  I added more detail on how to get
that sato example going.

(From yocto-docs rev: 3dd6217be5e6f73ba3927431105096aec1445e10)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-01-16 15:35:57 +00:00
Scott Rifenbark
2480e01188 ref-manual: Updates to FILESPATH and IMAGE_FSTYPES variables.
Fixes [YOCTO #13112]
Fixes [YOCTO #13115]

* FILESPATH: Added a detailed example of how to use the variable
  to set machine-specific configurations.  Also, noted the default
  behavior of using FILESOVERRIDES to automatically extend
  FILESPATH. Did some rewriting as well.

* IMAGE_FSTYPES: Updated the note to not be exclusive to "live"
  images.  The behavior applies to many images.

(From yocto-docs rev: 46e3f2545c45ba5391603f9ffa1c87896d472df6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-01-16 15:35:57 +00:00
Scott Rifenbark
70edcf9cf3 mega-manual: Updates to support BitBake User Manual
Fixes [YOCTO #12399]

Fixes made to have the BitBake User Manual included in the build
of the mega-manual.  I placed this manual at the end of the
mega-manual.  Following changes made:

 * Makefile - Modified to include two PNG files.  All PNG files
              in a given manual are listed in the area that makes
              the mega-manual so that the tarfile is complete.

 * mega-manual.xml - Updated the front wording to tell the user
              that the BitBake User Manual is included in the
              Mega-Manual.  Also, added a last section to actually
              include the bitbake-title.png file and the *.xml
              files.  Note that I could not add the title figure
              from the same figures folder of the local "bitbake"
              folder.  Would not include in the build.  So, I
              pulled the file from the figures folder of the
              mega-manual, which is what I do for all the other
              book titles used in the mega-manual.

 * mega-manual.sed - Modified to clean out the old stuff that
              had been carried along for older books not
              supported for the release.  Modified to include
              link processing for the newly included BitBake
              User Manual.

 * New Figures - Moved copies of the "bb_multiconfig_files.png"
              and "bitbake-title.png" figures into the
              figures folder of the mega-manual.

(From yocto-docs rev: 78a1ae0ca92bb7f8a9d3a32a320299371d0ed361)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:53:11 +00:00
Scott Rifenbark
2c0db14f94 ref-manual, overview-manual: Fixed BitBake User Manual links
Some occurrences of links to the BitBake User Manual were using
a target (i.e. &YOCTO_DOCS_BB_URL;#bitbake-user-manual).  Using
this form causes the mega-manual.sed file to not process the link
correctly for the mega-manual.  These are subtle errors and have
probably existed for some time.  I removed the target ID to fix
the problem.

(From yocto-docs rev: 701f61fd80e5103ee02efbe5eed9a8607ac9a336)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:53:11 +00:00
Peter Kjellerstedt
1e534573c7 ref-manual: Document the fifth argument to PACKAGECONFIG
(From yocto-docs rev: adb17e3172c829de77d2664c91f7cf4b22c9e5f0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-15 11:48:59 +00:00
Peter Kjellerstedt
989577c4ad ref-manual: Add missing whitespace around "=" in a few code examples.
(From yocto-docs rev: 0d22771c64d082bf86f5efd85ac9aaeb1c7f3093)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-15 11:48:59 +00:00
Scott Rifenbark
dfe7b95ea4 documentation: Preparing for 2.7 release.
Updated poky.ent to have variables for 2.7.
Updated mega-manual.sed file to use "2.7" string.
Updated all <manual>.xml Manual History Tables to use "TBD"

(From yocto-docs rev: d6f8bbd6e107913265ea1ac95ab8817e199ff60b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-15 11:48:59 +00:00
Scott Rifenbark
eda8ce60e1 poky.ent: Updated copyright variable to span into 2019.
(From yocto-docs rev: f06b1838f7f4516272aca290995f00f6fd16e35a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-15 11:48:59 +00:00
Scott Rifenbark
d29f4dcc45 ref-manual: Updates to CMake and cmake.bbclass.
I cleaned up the terminology used for the CMake build system.
I provided some meaningful links to a good overview page for CMake.
I also built in some cross-referencing as needed.

(From yocto-docs rev: 7c38add39b97a7a8786a1be53f9ff549e4727fad)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-15 11:48:59 +00:00
Armin Kuster
6b84ac7883 ref-manual: Updated list of supported Linux Distros:
Updates for the "thud" release.

(From yocto-docs rev: ccd2d2c7b062627a3fd1961ab23ee6fff714428a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:52 +00:00
Scott Rifenbark
8aba364ff9 dev-manual: Added note stating no WSL support
The Windows Subsystem for Linux is not supported.  Added a note
in the section on setting up the build host.

(From yocto-docs rev: e6c3b0acd77569e0422cf86e7dc56433e76bdf20)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:52 +00:00
Scott Rifenbark
10d53356a2 ref-manual: Added a note saying WSL is not supported.
Windows Subsystem for Linux (WSL) is not supported with the
Yocto Project.

(From yocto-docs rev: 0898d7fb7166da91598854f385cd574004098ac3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:52 +00:00
Scott Rifenbark
0e91bc0a6b brief-yoctoprojectqs: Added warnings about WSL, which can't be used.
Windows Subsystem for Linux (WSL) is not compatible with the
Yocto Project.  Added information in the beginning to note this
fact to the user.

(From yocto-docs rev: d8fcc0e3dc609086ca82a3419a337350f4e5c529)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:52 +00:00
Scott Rifenbark
58128d2b32 kernel-dev: Updated phrasing for what a "defconfig" file is.
It was over simplistic.

(From yocto-docs rev: 1c17e3ef607d18c89c3e20d2d44eb5120779cd2c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:52 +00:00
Ming Liu
236e2c80de ref-manual: Updated image_types.bbclass description.
The "image_types" class is now inherited mandatorily in
image.bbclass through the variable IMGCLASSES.  Users do not
have to inherit it in their customized image type bbclass.
They also do not have to put it in IMAGE_CLASSES.

(From yocto-docs rev: bd391092b216e39dad317dc1aae5c715371766ef)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:52 +00:00
Scott Rifenbark
4adb1e29a1 ref-manual: Added description for devupstream.bbclass
New section added.

Fixes [YOCTO #12732]

(From yocto-docs rev: 3d4a1fef8e1809cd7f1dece55790b6ee12dc60b3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:52 +00:00
Scott Rifenbark
e33920f4c9 dev-manual: Updated the "Post-Installation Scripts" section.
Added a better, more up-to-date description of the way to defer
a post-installation script past the boot.

(From yocto-docs rev: 1bcec14eed720fd05e81fbe7ecaa2f95174c0fbf)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:52 +00:00
Scott Rifenbark
69f269e090 ref-manual: Added cross-references to "Post-Installation Scripts"
Two areas in the migration chapter discuss the post-installation
behavior when you defer the scripts to after boot.  I added a
couple references to each of those migration note sections that
go into the dev-manual's section.

(From yocto-docs rev: eeb09b5fa208499f37be4e5aafcf55db82715fd1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:52 +00:00
Scott Rifenbark
108fe4b941 ref-manual: Updated "Packaging Changes" section for 2.6 migration.
Changed reference to "python-modules" to "python-modules /
python3-modules".

(From yocto-docs rev: 49d66f928366dda19b6afd1e9ac6431f0f66ab21)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:52 +00:00
Scott Rifenbark
028deee71f ref-manual: Applied review edits to the 2.6 migration section.
Minor fixes here and there.

(From yocto-docs rev: 740b4392bd98a12f188b79ae3ecdc7c3031f9f7d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:52 +00:00
Scott Rifenbark
83b605ccef ref-manual: New 2.6 Migration section complete.
(From yocto-docs rev: 6597ea2d706e3975ff0ffae15cf748ffd7aaed8b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:52 +00:00
Scott Rifenbark
184b441580 ref-manual: Added new python3 profile-optimization migration topic
(From yocto-docs rev: 2d0960d9282ffcb843ed9956a0e49183b22f11f2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:52 +00:00
Scott Rifenbark
40433a0229 ref-manual: Updated postinstall migration note.
(From yocto-docs rev: fa6582df36d770e7207e4c5201dafe0e64f46a76)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:52 +00:00
Scott Rifenbark
506bbde783 ref-manual: Updates to the 2.6 migration section.
This is the completed first draft.

(From yocto-docs rev: 45d39b7655ea5b515c8dda91249a84ee19387099)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:52 +00:00
Scott Rifenbark
2103d41b2e ref-manual: Added KERNEL_ARTIFACT_NAME and adjusted referencing variables.
The KERNEL_ARTIFACT_NAME variable is used throughout to set the names
of build artifacts.  Rather than repeat informaiton about
KERNEL_ARTIFACT_NAME in the many variables that use it, I added
a new entry for the variable.  This also impacted the descriptions
of the variables that were repeating information.  I updated those
variable descriptions as well.

(From yocto-docs rev: 5750d30be21e17fe21d89254925dc0e773c08e66)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:52 +00:00
Scott Rifenbark
b9834979b1 ref-manual: Removed the NOISO and NOHDD references.
(From yocto-docs rev: fdce52a34db29c98140daa05bd9c660a2494dc12)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:51 +00:00
Scott Rifenbark
dab1295f25 dev-manual: Removed occurrence of mkefidisk.sh script.
Script has been removed.

(From yocto-docs rev: c23de8eb2648f98864579e857a1de0b2ed74532a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:51 +00:00
Scott Rifenbark
c215b12caa ref-manual: Removed the NOISO and NOHDD variables.
(From yocto-docs rev: bdb67279cd6707e5b0141ecfbfbc09101d508ef4)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:51 +00:00
Scott Rifenbark
c029a905c8 ref-manual: Added several new sections to the 2.6 migration section.
(From yocto-docs rev: 54703fbde3f7808b9257da883fe8e4769a65fc44)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:51 +00:00
Scott Rifenbark
ab2b5029e7 ref-manual: Added new artifact naming variables to glossary.
(From yocto-docs rev: ed122fae8ec6e9eb38c196decfc6f5016945f4ee)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:51 +00:00
Scott Rifenbark
f148a5750d ref-manual: Changed "post 2.6" to correct wording.
I changed the wording "post 2.6" to state "2.6 and
forward".  It was incorrect as the changes are  inclusive
of YP release 2.6.

(From yocto-docs rev: fb3f3db17ea416cd829a291df3933cc3597392b8)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:51 +00:00
Scott Rifenbark
073df1158c ref-manual: Added KERNEL_IMAGE_NAME description
The KERNEL_IMAGE_NAME variable is new and is effectively
a renamed KERNEL_IMAGE_BASE_NAME variable now.  I provided a
new glossary description for the new variable.  I updated the
existing KERNEL_IMAGE_BASE_NAME description to note it has
changed.  We can't just delete the old variable as there are
migration notes for previous releases of YP.

(From yocto-docs rev: e5a38711342f88ded4368521a70e9d117b6d991c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:51 +00:00
Scott Rifenbark
b2e118252d ref-manual: Added GCCVERSION variable description to glossary.
(From yocto-docs rev: 8095f61c0bf0bbfc7fcf83e3f1c080913ed5f17d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:51 +00:00
Scott Rifenbark
ba78d21173 ref-manual: Updated migration section for 2.6
Made two minor corrections from reviewer feedback.

(From yocto-docs rev: 765e44127f52e1d9d4d1c365b0574ca73364add2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:51 +00:00
Scott Rifenbark
12eee34540 ref-manual: Updated 2.6 migration topic "_remove"
Provided more explanation and also a link into the BB manual
for a detailed example.

(From yocto-docs rev: ca1e113dc837f5104f765b655880a87d1fbd66ac)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:51 +00:00
Scott Rifenbark
016e34a2e8 ref-manual: Added the 2.6 Migration Section.
Provided some new sections on the information for migrating from the
2.5 release to the 2.6 release.

(From yocto-docs rev: dd721a31594c753d7229c45ebad0ce11640a0704)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:51 +00:00
Scott Rifenbark
53fa948ae3 ref-manual: Updated testimage and testsdk class descriptions.
I added notes indicating that the best practice for automated testing
is to inherit these classes by using the IMAGE_CLASSES variable instead
of the INHERIT variable.

(From yocto-docs rev: 8f4765db897c20f0011ea65f62d6b45495d313d2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:51 +00:00
Scott Rifenbark
01c64b6aa1 ref-manual, dev-manual: Removed TEST_IMAGE for TESTIMAGE_AUTO.
The TEST_IMAGE variable went away and was replaced with the
TESTIMAGE_AUTO variable.  Fixed all related/affected areas.

(From yocto-docs rev: 660da40b4fcdc05666e1877037fa63eb1dfe7227)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:51 +00:00
Scott Rifenbark
b131879f0c poky.ent: Updated release month to November 2018 (thud)
(From yocto-docs rev: b90dd0f7e8d6762bb5dafaedd10cbc01044635d3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:51 +00:00
Scott Rifenbark
21e5d8e2c6 ref-manual: Updates to variable wildcard support
Fixes [YOCTO #12390]

Updated three variables: BB_ALLOWED_NETWORKS, BBMASK, and BBFILES.
Fixed some linking to be sure to use Python3 links instead of
Python 2.  Fixed a note to clarify use of the "*" wildcard
restrictions in the BB_ALLOWED_NETWORKS variable.

(From yocto-docs rev: 6f880d10d0830d80cc2d4d1d5b7ea141dad6d4af)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-10-29 16:55:19 +00:00
Scott Rifenbark
bd6d8db54b ref-manual: Updates to the SSTATE_MIRRORS variable.
Accounting for uninative stuff.

(From yocto-docs rev: 5915f1345e3b91ae848cf419560d8fae4e850058)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-10-29 16:55:19 +00:00
Scott Rifenbark
21c7646779 ref-manual: Updated SSTATE_MIRRORS variable description
Fixes [YOCTO #11107]

Updated the SSTATE_MIRRORS variable description to include
explanation of how to use regular expressions to map file locations
to server-provided URLs to share sstate information.

(From yocto-docs rev: 1357095864ee919f576de8df36f4e177b24fdd22)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-10-29 16:55:19 +00:00
Scott Rifenbark
4b4b9c9c19 ref-manual: Updates to describe wildcarding support
Added specific wildcarding support descriptions for all related
variables and file panthnames.

(From yocto-docs rev: 543e398c4ae1bce38517a88cd91c957a583a2892)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-10-20 14:28:00 +01:00
Scott Rifenbark
afec74f512 poky.ent: Updated variable for "October 2018" string.
Manual revision history tables updated.

(From yocto-docs rev: c957e4ab60b4cf2778824162758b2b12bddcfafb)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-10-20 14:28:00 +01:00
Scott Rifenbark
6d9de01c18 ref-manual: Updates to native.bbclass
Fixes [YOCTO #12924]

Naming convention does not apply to the second recipe-creation
method described in this class.  I have moved the note about that
to be under the applicable method (i.e. the first bullet).

Fixed the syntax reversal of the sample name in the example.

(From yocto-docs rev: f7f1a89043156527fa4b426c0322ad225a9f2ff1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-10-04 14:33:50 +01:00
Scott Rifenbark
a2d14e5b6d dev-manual: Fixed poor writing
The bullet item describing what the LAYERSERIES_COMPAT variable was
written poorly (ending in a preposition).  I fixed the sentence to
read more clearly.

(From yocto-docs rev: 35d09727ab527df7d54ac1316c8e825f586ebc9a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-10-04 14:33:50 +01:00
Joshua Watt
1b18eaa376 ref-manual: Added "debug-with-srcpkg" option to package split variable
Added the "debug-with-srcpkg" option for the PACKAGE_DEBUG_SPLIT_STYLE
variable.

(From yocto-docs rev: 05c51e53059bf7c999a448402d60d0b16d62341b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-10-04 14:33:50 +01:00
Scott Rifenbark
9da59f02fc profile-manual: Provided links for two PACKAGE_DEBUG_SPLIT_STYLE references
(From yocto-docs rev: 5b49dc12f8102122c6b634f0c00bbd3c2f921936)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-10-04 14:33:50 +01:00
Scott Rifenbark
83270f0722 ref-manual: Updated TCLIBC variable.
Added "baremetal" as an argument.

(From yocto-docs rev: 34cb39334d0af43f3c184adbfc53270def394154)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-09-11 09:36:07 +01:00
Scott Rifenbark
e29bae3507 dev-manual: Updates to "Cloning the poky Repository"
Some re-wordings and also ran through the examples to produce
updated output.

(From yocto-docs rev: 306baeb24d2c6b45d09f44e8c8d5f55b9aef1b8d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-09-11 09:36:07 +01:00
Scott Rifenbark
ed84cafb03 dev-manual: Updates to "Cloning and Checking Out Branches"
Provided clearer text.

(From yocto-docs rev: 16b793389b359ee08b632d77c1d0abad4796543a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-28 10:30:43 +01:00
Scott Rifenbark
5c1c122563 dev-manual: Updates to "Accessing Nightly Builds"
Re-wrote section to provide more accurate step-by-step
instructions.

(From yocto-docs rev: dd1b5918d32b6272100fb59562de37f9a191e7ab)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-28 10:30:43 +01:00
Scott Rifenbark
1331cc8c8a dev-manual: Fixed typo closing parenthisis.
(From yocto-docs rev: d78dddd9c81c6c182a14ab5fb15b5c80caf2bf86)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-28 10:30:43 +01:00
Scott Rifenbark
a512748684 dev-manual: Updated general multiconfig syntax.
A task or package can only depend on a task... not a task
or package.

(From yocto-docs rev: 63f14e131ebf2bb8379a07f8958bf69a06af1124)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-28 10:30:43 +01:00
Scott Rifenbark
accd9e7b62 dev-manual: Updates to section on multiconfig builds
* Added qualifying text indicating that you can build images or
packages.  In other words, the multiconfig does not necessarily
have to be an image.  It can be a package as well.

* Added qualifying text describing that it is not a requirement
to have separate TMPDIRs for each multiconfig.  I used a build
for two multiconfigs of "qemux86" for different DISTROs as
a case.

(From yocto-docs rev: 6e5ed0d1ab305c3382fea55fc1a2deaac0b7d518)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-28 10:30:43 +01:00
Scott Rifenbark
2d3a811338 dev-manual: Updates to "Locating Yocto Project Source Files"
Some edits for clarity and fixes to the procedures regarding
the DOWNLOADS page.

(From yocto-docs rev: 98ee61f7797c9352a1eff060b98a3e2e74a1da6f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-28 10:30:43 +01:00
Scott Rifenbark
f08a41e9ef dev-manual, Makefile: Created new section on multi-config build deps
Rewrote the section on setting up and executing multi-config builds.
Broke the section into two sub-sections.  One is for the standard
information that was there for setting up a multi-config build. A
new section was for the cross-build dependencies in multi-config
builds.

Part of the re-write included creating a new figure that shows
the configuration file hierarchy needed for these types of builds.
So, new figure added to both the dev-manual and the mega-manual
figures directories.

Finally, the Makefile needed updated to account for the new figures.

(From yocto-docs rev: dc158e97c216aa6e7fa3755164409d581f8569c5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-28 10:30:43 +01:00
Scott Rifenbark
48b17b2bfe dev-manual, ref-manual: Changed section heading for multiconfig builds
Changed the section heading in the dev-manual for building images for
multiple targets useing multiple configurations.  This wording is
more accurate.  I updated the link from the BBMULTI_CONFIG variable
description as well.

(From yocto-docs rev: 3b2f95c3c54bed7ab8b4673ba7a254d31bea811b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-28 10:30:43 +01:00
Yevgeny Popovych
e0e333b485 ref-manual: Removed misleading paragraph in siteinfo.bbclass
The section on the siteinfo.bbclass file had a paragraph indicating
base.bbclass included siteinfo.class.  This is not true since
2010.  I removed the paragraph.

(From yocto-docs rev: 5d39220baddc9db5c1182cea8447e5c4a2e42bd8)

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
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
Scott Rifenbark
3e3f6d55b1 ref-manual: UPdates to the PNBLACKLIST variable description
(From yocto-docs rev: c8a606dbce01132e95250c33270ff729cadc2c0e)

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
720baedefc sdk-manual: Minor intro wording change
(From yocto-docs rev: 953db3d0b5fe14411e944b021a2f6f50a5bdeabd)

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
601e84c204 ref-manual: Removed non-existant variable from PACKAGE_WRITE_DEPS description
Took out an occurrence of PACKAGE_WRITE_DEPENDS

(From yocto-docs rev: f7b2c7c08f3f504e14943a01e7fc0a73c96e9636)

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
f4d1317d8f sdk-manual: Fixed bad anchor string.
Broken link fixed.

(From yocto-docs rev: 420bc55ceac1d8c89f9153a70c8b4e3ca38d747d)

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
880c15fe31 sdk-manual: Updated section on minimizing eSDK installer size
I made some re-writes for clearity.

(From yocto-docs rev: a68619a2ba8b7877cde6c9ef7dbb726adc75b0cd)

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
bfe4fef098 sdk-manual: Converted bullet list to ordered list
On second thought, the list I turned into a bullet list from the
previous commit was a bit hasty.  That list is order dependent.
Reverted the list.

(From yocto-docs rev: 9ea640ffea2a2c9827f18070a5b287453c8653e9)

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
5cdf2e8b2c sdk-manual: Updated "Providing Additional Installable Extensible SDK Content"
The list appears to be not a numbered list.  Fixed that.  Also, provided
better wording around "exposing" the sstate-cache.

(From yocto-docs rev: 15c65db41c9e6eddf7d12e138f6c63755e845beb)

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
c89427bebe sdk-manual: Provided better wording for sharing HTTP or HTTPS server
Step 1 of the "Providing Updates to the Extensible SDK After Installation"
section really did not do much for the reader regarding setting up a
HTTP or HTTPS directory.  I added more detail on how to generally do
that.

(From yocto-docs rev: ff250cea239668db5fe26aa912942c0d142833fa)

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
bf5e8e860c sdk-manual: Edits to the section that changes the sdk title
Made some suggestions on how and where to edit the SDK_TITLE
variable.

(From yocto-docs rev: 4a4393e00c7108eefaaeaa3951a75524589bf360)

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
9af1d60bcc sdk-manual: Updated section on changing SDK installer title.
I added more detail to this section.

(From yocto-docs rev: 15beb33eadd03391a1af0c9bad0620cefad2a0e2)

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
9fc6304bf8 ref-manual: Updated the SDK_TITLE variable description
Provided more detail and a cross-reference into the SDK manual
where you can change the title through the variable.

(From yocto-docs rev: 9617fa70caef48328455a02d5260e536fac19c53)

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
55d5355b84 sdk-manual: Added section on changing the default ext. SDK install directory
(From yocto-docs rev: d3f0c7b9e2ddea3fec6f42fc9a3c8806b02119f3)

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
0efdd1d4da ref-manual: Added SDKEXTPATH variable description.
This variable is the default installation directory for the
Extensible SDK.  By default, it is "poky_sdk".  You can override
this variable so it needed to be documented.  The ideal place to
override it is in the distribution configuration file.

(From yocto-docs rev: 67eca50fa973073ce6e7975ab66b89b9706c25c0)

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
3b374b09df sdk-manual: Updates to sections for updating installed Ext SDKs
There are two sections that deal with this topic.  One is from the
standpoint of a user using a 3rd party published and installed
extensible SDK ("Applying Updates to an Installed Extensible SDK").
The other is from the standpoint of a person providing Extensible
SDKs for consumption ("Providing Updates to the Extensible SDK
After Installation").  These sections needed some closer examination
regarding fully describing what was going on.  I provided some
re-writes to both.

(From yocto-docs rev: 1c60b13b5f1813d6e3688e1efce32b7f31422e86)

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
6cb9fddcab sdk-manual: Changed title to updating the SDK after install
The title for the section on how to effect changes to an installed
extensible SDK is better suited as "Providing Updates to the
Extensible SDK AFter Installation."

(From yocto-docs rev: 2120ba194abada1769be28ae2737ac12a16adebc)

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
67654c6100 sdk-manual: Fixed grammar error
In "Providing Updates After Installing the Extensible SDK" section,
Step 1 had a bit of a grammar error.  Not technically, but it
could have been written better.  I fixed that.

(From yocto-docs rev: 20f1cad5a813697afd99837699bf52a6586893bb)

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
5e1a56eca6 sdk-manual: Updated section on changing title of extensible SDK installer
I added more information on how this is done.  Still could use a bit
of detail on how you actually do it.

(From yocto-docs rev: 007bbe40fd11a5f880adf7ad8137d1535f08c815)

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
895feaac61 ref-manual: Updated DISTRO_NAME variable description.
I provided some real detail on this variable.  It was woefully brief.

(From yocto-docs rev: 4282fabddc81bf4c0fbd0a641ec4f1e9754660c2)

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
91c70cf4a0 ref-manual: Updated the DISTRO variable description
I added a cross-reference to the "DISTRO_NAME" variable as it is
the long version of the distribution name.

(From yocto-docs rev: bb5638409faadb9c6a5fbca729e4e6b8a220433d)

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
059d5e6e57 sdk-manual: Grammar fix
(From yocto-docs rev: b850e0d520401a52fbba083975f05f529b2b554d)

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
16eddf2be6 sdk-manual: Updates to "Adjusting the Extensible SDK to Suit Build Host"
I updated this section with clearer text.

(From yocto-docs rev: 433388ff37297d905c465a5f05d93953dfe062c5)

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
450a3d75f8 sdk-manual: Updates to "Configuring the Extensible SDK" section
Made improvements to this section and tied the variables together
for the explanation.

(From yocto-docs rev: de882b81ed8525dee5e10f247cc6f5c8f15e0f72)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:42 +01:00
Scott Rifenbark
eabfa9f398 ref-manual: Fixed cross-reference wording in SDK_LOCAL_CONF_WHITELIST
Wording did not match that of similar SDK variables.

(From yocto-docs rev: 696eb9ff0b89222dc696adc0bd28247c0a0c731a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:42 +01:00
Scott Rifenbark
f0fe442143 ref-manual: Fixed grammar error in SDK_INHERIT_BLACKLIST description
(From yocto-docs rev: 0a5775f7ad3e0b6531fcfd1d328d8e0da8727400)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:42 +01:00
Scott Rifenbark
4d1feb55fa ref-manual: Added cross-reference to SDK_LOCAL_CONF_BLACKLIST var
Put in a cross-reference to the section in the sdk-manual where it
talks about customizing the configuration of the extensible SDK.

(From yocto-docs rev: 062db19dd56cc1827ebd7614eb8a54660421df62)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:42 +01:00
Scott Rifenbark
701e9c3fe5 ref-manual: Updated the SDK_INHERIT_BLACKLIST variable description
Added information on the class in which the default is set.  Also,
put in a reference for more information on customizing the
extensible SDK configuration.

(From yocto-docs rev: a0145996aeac1bb45fea9f613789b00327f92d1e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:42 +01:00
Scott Rifenbark
e9fd884751 ref-manual: Updated the SDK_LOCAL_CONF_WHITELIST variable description
Enhanced this description by indicating the class that it is set in
and by including a pointer back into the sdk-manual where filters
are described for extending the extensible SDK.

(From yocto-docs rev: 355b05366aadc337ec3337c0a3c918a23027923b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:42 +01:00
Scott Rifenbark
267aa12a2c ref-manual: Updated the SDK_LOCAL_CONF_BLACKLIST variable description
Added more detail including the class that sets the default variables
for exclusion and the list of actual variables that are excluded by
default.

(From yocto-docs rev: f24287851998d554575c6aaf9dcc50d198931e48)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:42 +01:00
Scott Rifenbark
2c8cc82b3e sdk-manual, mega-manual: Updated the fig for installed ext. SDK
This figure had changed.  I updated the file and folder hierarchy.

Also fixed some wording.

(From yocto-docs rev: 359292397781f9f5eac2fb693d89ec286ddf9940)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15 10:28:42 +01:00