Add IMAGE_LINK_NAME to the variable glossary.
(From yocto-docs rev: 370551f961a291f7090a8a40a0beea3511274bc1)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This covers most of the changes that would require action on the part of
the user that I was able to see by scouring the commits. Some of the text
was borrowed from commit messages and edited.
(From yocto-docs rev: 35e9349ba6417765274d7d1ce542e7e6f19dbe26)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add a variable glossary entry for IMAGE_NAME_SUFFIX, which was added way
back in krogoth.
(From yocto-docs rev: 78920a8ea5fb991606300c1fcb48aa6a7c20f8c1)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add an entry to the variable glossary for IMAGE_VERSION_SUFFIX (which
was added in thud) and update the IMAGE_NAME and KERNEL_ARTIFACT_NAME
entries whose defaults use this variable.
(From yocto-docs rev: 1a02c4be8e348687d4f7e09aefc408aaed5f1be5)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add a brief variable glossary entry for the new PSEUDO_IGNORE_PATHS
variable.
(From yocto-docs rev: a337bb317dacdeb174397e7ee8258bc74560436b)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Update for changes to messages
* Add missing QA checks - some added recently, others several releases
ago
Some of this was borrowed from commit messages (with editing) - in
particular thanks to Alexander Kanavin for the writeup on patch-fuzz.
(From yocto-docs rev: 6a5e846a92068758e49d1810789638b6990bf83d)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
distro_features_check was renamed to features_check and extended to
support MACHINE_FEATURES, COMBINED_FEATURES and ANY_OF_*_FEATURES in
dunfell, but the documentation still needed to be updated.
(From yocto-docs rev: 274eb596582a22883e8b386a07cf32ed45a77d79)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Make it possible to link to the explanation for a particular QA check.
(From yocto-docs rev: 3f6dc24e0a371feca8fe66c1be8c86e599307854)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Adds documentation that describes how to use the --offset argument in a
kickstart file
(From yocto-docs rev: 0fbb2d71fe866b4ae7721f2f70d5b50dbc019030)
Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Everything declared in a glossary has a "term-" link that is usable as an
HTML anchor. The link already works, one just cannot get a link from
within the ref-terms page.
Let's make this possible.
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
(From yocto-docs rev: fcbb267fba968834d4d9d011fc71cc371f910447)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Adds an example to SRC_URI that explains how to name sources in SRC_URI
and how to associate SRCREVs and checksums with the names
(From yocto-docs rev: 900af0addab7d6ea465922957f881a13012429ed)
Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Tested with containers on all supported distributions.
Debian 8 (Jessie) still has Python3.4 and an old pip3, which makes it
impossible to build typing module which is a requirement of "new" Sphinx
python module.
One cannot update to latest pip3 from within pip in Jessie's version.
One cannot get a newer pip from upstream because newer pip don't support
Python3.4 anymore.
One cannot build with python3-sphinx package from Jessie because the
package is too old (1.2.3) and does not have sphinx.ext.autosectionlabel
module which appeared in 1.4 version.
(From yocto-docs rev: 14da565986a573ac7e0b5c5943e55b7b74f99dd5)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
tinderclient class was dropped in dunfell.
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
(From yocto-docs rev: 241059880bbfa61b61cf1843447e1b6d57c71ebe)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There's probably no need for such a variable (the name of the script is
unlikely to change any time soon) and not all instances of
oe-init-build-env were actually using this variable.
For consistency sake, let's just remove the OE_INIT_FILE variable.
Suggested-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
(From yocto-docs rev: 6fd4421283005b0ecc980e9ef25770d383b93937)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Deleted content about old spdx.bbclass.
- Added usage of meta-spdxscanner.
(From yocto-docs rev: 59908cecb5283ebdea1800c4d86a6310a45159bf)
Signed-off-by: Lei Maohui <leimaohui@cn.fujitsu.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
When the license identifier tags were added, an incorrect string was used
and the Share-Alike clause was lost. Fix this to match the license
description in the files and add back the lost piece (its clear from
the history it should be there)
(From yocto-docs rev: 8d30c3d792755a7bfdb74b331dad98f51d3516af)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The Yocto Project documentation was migrated to Sphinx. Let's remove
the deprecated DocBook files.
(From yocto-docs rev: 28fb0e63b2fbfd6426b00498bf2682bb53fdd862)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Before the move to Sphinx, it used to be possible to get a direct link to a
variable from the term glossary. It is very useful when pointing people to
a specific variable when manually looking for it in the glossary.
Let's add this "feature" back.
(From yocto-docs rev: 9e468274eaad270efd5f50e58a523798fcb8097e)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Since the move to sphinx, variables aren't linked with var- anchors but
term-.
Let's fix that so clicking on a letter will bring to the correct variable
in the page.
(From yocto-docs rev: 07718faa04a8b121be004afbc23b4c338f669413)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This documents the variables used to create keys for
signing fitImage.
(From yocto-docs rev: 7d0407249907259b59191e3759a3b140d30d993e)
Signed-off-by: Usama Arif <usama.arif@arm.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
IMAGE_EFI_BOOT_FILES created to help differentiate files needed between
bootimg-efi and bootimg-partition when creating the installer/.wic file.
(From yocto-docs rev: 3430e56aaa8a528a062af534610dc60346347947)
Signed-off-by: Khairul Rohaizzat Jamaluddin <khairul.rohaizzat.jamaluddin@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In order to be able to build this example from anywhere, one needs
to give the relative path from LAYERDIR to the .inc file.
The path is the one for the inc file from openembedded-core.
(From yocto-docs rev: cb92d16a6d638f39effa06a7334496f1b0c83b2a)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The 2.3 example was not working anymore so fixed it and upgraded all
at once.
(From yocto-docs rev: 12457c2410c4f0bfda254ceb4f5ef35127a7540f)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This avoids the duplicate heading warnings at the slight expense
of more directory clutter.
(From yocto-docs rev: ef896d71836aa3bd6c926b36976a9c45d5f2ca15)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
(From yocto-docs rev: d694ff63f4aee0fff6eac0541413c1a36b3b02e2)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
(From yocto-docs rev: a95b49eef8f6bfde153677dda8021ffadf29d8f7)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: 43f042582675f89fcdf81c0cd2ac2602d4282cb3)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
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>
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>
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>
* 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>
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>
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>
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>
(From yocto-docs rev: a9a3248b12b85f3637ebe5eddd4b1a29268d5598)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: 5582f01fc4774e7d21af24627bbd47a77463d272)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
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>
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>
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>
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>
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>
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>
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>
* 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>
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>
* 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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
FIXES [YOCTO #12734]
Added a new variable description and created a new
section in the dev-manual.
(From yocto-docs rev: 854e641482171585c96ee5b9387b3e64146072b9)
Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Renamed to "Speeding Up a Build" and moved out of the setting up
chapter to the common tasks chapter. Fixed a couple links in the
ref-manual.
(From yocto-docs rev: c53fddd353230c8ef1abc21c7a2d2b1f492f034a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed to "Locating Yocto Project Source Files". I am moving the
sections on cloning repositories out from under this section.
(From yocto-docs rev: 3889aadab9b603097b6cc5b7afb9d0066021106c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section on licensing in the overview-manual was really "how-to"
information. I moved this to a new section in the dev-manual for
"working with licenses". I fixed some references in the ref-manual and
in the bsp-guide as well.
(From yocto-docs rev: f150a1ea2da900aae88fc5fa60f4115cc213ba2d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The Wayland and Weston topic moved from the overview-manual to the
dev-manual. The lone link to this topic was in the ref-images
chapter. I updated the link.
(From yocto-docs rev: 6c335f8d3618e3285f91fe20aea33a1c1f1c0ddf)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Now that 2.5 has released, I replaced the ENTITY variable used for
the moving month and year with the actual release month and year
(i.e. May 2018).
(From yocto-docs rev: 2d6e8ddce4fce0c405d2aea69cea2a5b262410f7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added more realistic information on how this variable is set.
(From yocto-docs rev: 47e6cb7d00eeb8001c4a53c13600feb5ef4d4660)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The note about the TAR backend not working was changed to soften
the warning. It has "limited functionality" rather than
"broken".
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This variable plays a much smaller role since recipe-specific
sysroots were implemented. I have rewritten the description to say
that STAGING_DIR helps construct the recipe-sysroots directory.
(From yocto-docs rev: c1ad18abe67111738efc18725c4f7706b55738cb)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a reference to the STAGING_DIR_HOST variable, which is part of the
default directory used as the shared, global-state directory holding
data generated during the packaging process.
(From yocto-docs rev: d68dcec327e96f1da0879681dcde43d4f1769af0)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Re-oredered the four options to be alphabetical.
(From yocto-docs rev: 7976ee05c935fd6c24abea99f71436003656cc73)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added some key references to the patching areas of discussion across
the manual set.
(From yocto-docs rev: f198529b3072a4a03fd368ea307e8e004c46a344)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The file:// protocol is primarily used for digging out patch files that
are local with the metadata (layer). I put a link in the paragraph that
is talking about them to the "Patching" section in the overview-manual.
(From yocto-docs rev: 18a7b4b81d192fb2cfd96763de4cfabd61c3a0ea)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Mentioned the role of SRC_URI earlier in the description as it is key.
Replaced "some_recipe" with "some_package" as the emphisis is not on
the recipe at that point in the example.
(From yocto-docs rev: f7f86941fdf866a693386335374f835078db3ddf)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added more content to this task description to help describe how
patching is performed and how the task uses the "apply" parameter
that can be provided with the SRC_URI variable.
(From yocto-docs rev: 6717a3326b0005f6a57be4cc026693b7cd9e8d08)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a new feature (task) to the list of available features you
can use with the variable. The "task" feature saves output file
signatures for sstate tasks.
(From yocto-docs rev: 0669580ce40c46f0b5f8204a6b00e11f725a383c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Provided a more complete and clear description.
(From yocto-docs rev: 65505debfb82536e7e2d4ff7e5bc14c6af1a7cf6)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added a link to the BUILD_ARCH variable. The variable is part
of the glossary but for some reason there was no link to it.
I also added a note for a link to the SDK_ARCH variable, which
was described inline. By convention, I do not like to link to
variables inline as the underlining used to indicate a link messes
with with underscore characters that are usually a part of a
varible's name.
(From yocto-docs rev: a2f487141375ee7ce226eece85424e709ddc67a3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The method for accessing the YP Release Notes for YP 2.5 forward
is to go to the "DOWNLOADS" page of the main YP website and then
click on the "RELEASE INFORMATION" button. No longer does a user
need a simple URL. I updated the two spots in manual where this
information existed for accessing Release Notes.
(From yocto-docs rev: 1e171d3add1048fb81c5a05a11c8ddbaf88e0ecd)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Provided a link to the YP implementation of Bugzilla. Added a final
paragraph noting the Bugzilla website if you want general information
on Bugzilla.
(From yocto-docs rev: 78c99c8f42edfee377431cacc10b9ccd4b25c4cf)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Link was not going to the top of the chapter.
(From yocto-docs rev: 52da20604a54d16645b4bb4e5e9efa748a00d2f5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed redundant link to CFLAGS in the TARGET_CFLAGS variable
description.
Removed redundant link to CPPFLAGS in the TARGET_CPPFLAGS
variable description.
(From yocto-docs rev: aa95485d44f92b831cd111dbc5bf75526d239db4)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The wording to two links (one a variable and one a section in a
different manual) was ambiguous. I added phrasing to remove that
issue.
(From yocto-docs rev: 3b70b4287ca8b2583e0ef559125f1531a2bb6a67)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed the link to WORKDIR to begin with. Also, removed the
<filename> formatting that was within the example, which is buried
in a <literallayout> tag set. Doing that screws up the formatting.
(From yocto-docs rev: 0d13dabaa13e5426da35b5d8147f51efa349b5bb)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added "class" as a modifier after refering to the "populate_sdk_base"
class.
Removed link to the TMPDIR variable in an in-line example.
(From yocto-docs rev: 7733a4464ba2893a2363f47996f48587a86eaa82)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Several redundant links and wordings in this description.
(From yocto-docs rev: bb9dd8ab6ef9cad387cdddada4f2be093551e38a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A migration item had taken the original section for the target of
the link out. I had not changed it.
(From yocto-docs rev: 10cfaee50455bf10450540f1b381d33f9babf985)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Two instances where links were going into the kernel-dev manual
but the manual title was not being used in the text. Added it.
(From yocto-docs rev: 1922f8c79d1667db1fc9b5fe57030302469ca09c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The link was to a chapter in the existing manual. I do not
include the manual title when that is the case.
(From yocto-docs rev: 1b7c65b4a2dde3f5d069cb5edc75728492639870)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Link was going to TARGET_PREFIX.
(From yocto-docs rev: 424e8ea3168ab2e910919e6f70fc0b16332ca4f7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I replaced the "<" and ">" constructs with the tags
<replaceable> and </replaceable>. This is the preferred formatting
for user-supplied values.
(From yocto-docs rev: 1fc32486483c545671ffb2142b553da75dbe54fe)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the BBMASK variable, a link to Python documentation was
going to a specific 2.6 release. That release was probably the
most recent when the BBMASK variable was initially documented.
Python has many releases now (e.g. 3.6.5). I re-worded the
description to be more generic and sent the user to the general
Python release area. They can pick a release from that URL.
(From yocto-docs rev: 154aedf79625f37997bec18dba933c514072708e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed the first link to the BB_DISKMON_WARNINTERVAL variable.
The variable was linked later in the text. No need to link
the output version of the variable... clunky looking.
(From yocto-docs rev: ec6cfc85ba2f1e2fc763b6b7c918a21cec00e203)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed wording so I could reference the proper name of the
LABELS variable.
(From yocto-docs rev: 05e5f287bde8219d1f8125d71fd48a36a422009a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The actual title of the sdk-manual does not include the word
"Manual". So, the reference to the book should terminate with the
word "manual" in lower case.
(From yocto-docs rev: 41bc85776f0b172fc243b6e5a5ca13b72e8399e5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The link was just going to the top of the section. I added an ID tag
to the actual host-user-contaminated test within that insane.bbclass
description. Now, the user is linked right to that test.
(From yocto-docs rev: b1e5b5a1876e211a8c57bfa727fa9031cfe5e0ac)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Had the wrong ID in there.
(From yocto-docs rev: 6d52354b42709867ef61543de6d3b630fd780bab)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The focus of the discussion here is on the DEPLOYDIR variable.
Having the link to the variable DEPLOY_DIR adds clutter to it all.
Removed that link.
(From yocto-docs rev: 8561c70fcff88adc82c7c5998d2539d40b314888)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Took out stange parenthetical construct and the links to the B and
S variables. Links were redundant. The construct was weird.
(From yocto-docs rev: 9cd2bf116bd89288a93944359a4809e68fa61f7b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A "naked" reference to the bsp-guide was split across two lines
in the *.xml file. This splitting causes the link to not be
processed correctly by the mega-manual.sed script. I joined the
two lines to fix the link.
(From yocto-docs rev: e31b4d2210b5c246f3e822fbe8950a625e08ca98)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Missing this conventional part of the reference contextual diatribe.
(From yocto-docs rev: 5468ebf21bc9166de35e9b7016eef06ed586e5c3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Trying to get back to a standard of using an actual link for only
the first occurrence of a variable in any given section.
(From yocto-docs rev: 68d80a5dd8481f938892473c4671a9c436e80c8f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the migration section, an older name for the bitbake-user-manual
was being used in the text for a cross-reference. I replaced it
with the current and correct name.
(From yocto-docs rev: 3f466b59a3138984cceae12ac58c84ec3cda4432)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the migration section, an older flavor of the title to the
sdk-manual was being used. This of course was not processed
correctly by the mega-manual.sed script. I fixed the title so
it is now processed correctly.
(From yocto-docs rev: 1f9fa699bb14f96a7c9ccab314a7d72e6a93dda6)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The terms.xml chapter had a link to the toaster-manual where the
string to the manual was not matching the string used in the
mega-manual.sed file. Consequently, the link was not being processed
correctly. This type of link should not be a link in the mega-manual
because the target is to the manual in general. Fixed the string
of the toaster-manual to match what is being used in the mega-manual.
(From yocto-docs rev: 44042847db10b15f8694199162ad96dea44d21bc)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Found a link to the old kernel-manual in the reference manual.
This manual is not used. I changed the link to use the proper
ENTITY value and also removed the old one from poky.ent.
(From yocto-docs rev: f1377989ab4a85827f5aaab9b19c4fb3c10567ca)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This involved changing the root manual folder from
"getting-started" to "overview-manual".
Also, every link using the ENTITY "YOCTO_DOCS_GS_URL" was
changed to "YOCTO_DOCS_OM_URL". Most manuals had several
occurrences of these links.
The makefile needed updating to process the new manual
and not process the old "getting-started" manual.
(From yocto-docs rev: 1abf64e56e9096258038ae37b787a81bf786bb3b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Throughout the documentation, the manual "Getting Started With
Yocto Project" was used. The manual now is called "Yocto Project
Overview and Concepts Manual".
(From yocto-docs rev: f47d10029487420cbeb292f680084b63be0ec7e9)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The concepts-manual is going away for 2.5. I have fixed all the
links across the YP documentation set that were cross-referencing
into the concepts-manual so they now cross-reference into the
getting-started manual, where that concepts chapter will live
post 2.4x.
(From yocto-docs rev: e9145e9e7fef882a13c982d34514a94f864b3c12)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed all the references to the top-level of the old
concepts-manual. These references are references that do not
have a "#" target. They just reference the manual in general.
(From yocto-docs rev: 5b33f3c119807532aa6feb2d010c9c9f780a26d8)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some inconsistencies in the links to the concepts-manual existed.
I fixed these throughout the YP manual set.
(From yocto-docs rev: ad7f840bb6f4a5248ef455b98ce9b35197e07e1a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There was inconsistent use when referencing the getting-started
manual. The manual's name does not include the word
"Manual". So, I cleaned this up across the manual set and
also in the mega-manual.sed file, which was incorrectly
processing the links to that manual that do not target a
specific section.
(From yocto-docs rev: 0f5321416f7ec50cb6c96cccb7c87ef191a25367)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Found a few links that were not using the correct wording when
referencing a section to the dev-manual. Also, fixed one link
that was assuming a section outside the dev-manual when the
link was to a section inside the dev-manual.
(From yocto-docs rev: 7a577b135e1a01d6a9924ba89733e46d029c6cca)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Throughout the manual set, I made sure that "OpenEmbedded-Core"
and "OE-Core" appear with the hyphens.
(From yocto-docs rev: 1f570df3eccb74b9e2e60af94c0e0dd48e1489e9)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Using "OpenEmbedded-Core" rather than "OpenEmbedded Core" in the
text. The term as also fixed to reflect this change. Also,
use of the phrase "OpenEmbedded-Core project" or "OE-Core project"
is not desirable. Changing project to version.
(From yocto-docs rev: ec226fcd92847c96ea2e11d34513b597a35c9825)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Minor re-wordings from review.
(From yocto-docs rev: d4598e7e43a8bafa4ff6ddeec50febcedc41b411)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated section IDs for the new Using Eclipse Neon
Appendix and Chapter 5 Working Within Eclipse (Oxygen).
Changed one link found in reference manual.
(From yocto-docs rev: d767007cf4151127063d1992a4e11e90437ae2da)
Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The original Yocto Project Quick Start is being retired for the
YP 2.5 release (sumo). I have purged all the various references
from the YP manual set and replaced them with references to the
appropriate doc. The references were mainly into the YP
dev-manual for setting up the host or for building an image.
There were a few references into the new "Yocto Project Quick
Build" document for overviewing manual-type references.
(From yocto-docs rev: 11c0ab693962f16f87f1e21f33dd5c6ca6a6f895)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This information was merged into the BitBake User Manual.
(From yocto-docs rev: eb68d4429aed652e4ca10c1ab55d3a815d453d6f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I did some re-wording to account for when the user does a web
search for a manual and the search returns an ancient version
of the manual. Many times the user is oblivious of this fact
and is trying to use a version of the docs that don't come close
to matching the version of the YP.
(From yocto-docs rev: 1cbe06cefda2b35584a8365564e01888d229d0b3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a final paragraph that provides some cross-referencing to
the sections that describe how to use Wic and to the Wic
reference chapter.
Also, shortened the DOC info line.
(From yocto-docs rev: 4ba5d0119caa3696187537f5b4cc9c64ca00e205)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a link to the "getty" term.
(From yocto-docs rev: d21fe1ea33353e15c135af7fc302ffe636310541)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Minor edits for clarification.
(From yocto-docs rev: fdef057927b7b0dba64b9b7f952108fdb9c97f34)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added minor edits to clarify that we are talking about an
image type.
(From yocto-docs rev: 14c906aa539d127c88d71d7fb3e628fc225cbd52)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Created a new variable description in the glossary. This
variable is used in the layer.conf file and needed to be
documented.
(From yocto-docs rev: 5c514c0e90ca920bdf183b1f9449a06b906235ca)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This is a layer that contains other layers
(From yocto-docs rev: 0cd1881c18e8a63d5f2f078b03fe4e89fd9c75b5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added the fact that this variable is really optional. If you
don't use it then you are setting up a package feed URI that
will include all supported arcchitectures for the package.
Using it means you are setting up specific URIs for specific
architectures.
Added a "Tip" note box to show how you can use the variable
to whitelist architectures.
(From yocto-docs rev: 009f3551aa61aaf6459fd24105a2e06511b59da3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I created a two-bullet "Caution" note to highlight the stuff a
user needs to be aware of that can cause problems.
(From yocto-docs rev: 553bc13e5fd350adb15400afe170e587965929db)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the devtool add -h output.
Updated the devtool --help output.
Fixed wording for the "attic" file associated with the figure
of the workspace area.
(From yocto-docs rev: bc53d9a1236ba2545c112256e886729b08b507de)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Provided a bit of rationale on why and when you use this command.
Put in several links to help the reader get to related areas where
command use is explained.
(From yocto-docs rev: 7b30f29bfa15dd15f1388bb856e2047be55e7fb9)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Provided more details in the explanation and fixed a link to the
section on using virtual providers.
(From yocto-docs rev: ace74e24f001b83c9177266b0a6f15ce96dd04b0)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed [YOCTO #11525]
Created a note for more explanation for how the
mount program understands the PARTUUID syntax
used with --use-uuid. Added four missing options.
(From yocto-docs rev: d8adf537d305dd55e841dd993c36ee60b5896adb)
Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
It is Pock-ee with the emphasis on Pock.
(From yocto-docs rev: fd0accf40a9324060562b75ba9d3b078daf458f6)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section that provides a closer look into the build system has
moved from the getting-started manaul to the concepts-manual.
I fixed all the links, provided some coded formatting of the
entire section, and made general updates.
The other manuals had links that needed fixed due to the move.
(From yocto-docs rev: b83a5619f56ebd9879fdcadcf474859e68b26d58)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added the concepts manual, the ref manual, and the mega-
manual to the list.
(From yocto-docs rev: 180387ac9ae74cd5b69c4cf6338b72daef4b9f37)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Creation of a new concepts manual and moving of chapters from the
getting-started (overview-manual) caused many links and manual
reference titles to break. I fixed these throughout the YP
docs.
(From yocto-docs rev: 30f2bc46be4a0faf5302eb8605bcb29f3bee6cf3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
When I converted the Yocto Project Overview Manual to the Getting
Started With Yocto Project Manual, I updated the strings for
references from "&YOCTO_DOCS_OVERVIEW_URL" TO
"&YOCTO_DOCS_GS_URL". Unfortunately, I did it with a global command
that did not take into account the text the might follow the link
by saying "see such-and-such section in the Yocto Project Overview
Manual." So, I had to hand fix these.
Additionally, since I have moved a deeper concepts chapter that
was in the getting-started manual to a new Yocto Project Concepts
chapter, many of those links changed had to really go to the new
manual instead. Those were fixed.
(From yocto-docs rev: fca1c56b0764802fb6a687ea81ab0fb95186cf0a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Creation involved removing the overview-manual and replacing it
with the getting-started manual. All links to the string
"&YOCTO_DOCS_OVERVIEW_URL" had to be replaced with
"&YOCTO_DOCS_GS_URL" across the entire YP manual set. I renamed
files used to create the manual with prefixes suited for the
new manual name, which is "Getting Started With Yocto Project".
The style sheet for the new manual needed updating to display the
new .PNG image for the title page. The mega-manual file had to
be updated to include the files. The mega-manual.sed file had
to be updated to include the new manual and not use the overview
manual.
(From yocto-docs rev: 6c7abf9192390121000f577d6c98f259d290d15d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12370]
The section on "Speeding Up a Build" that was in the ref-manual
needed to be in the dev-manual as it is a "how-to" section.
Moved it.
(From yocto-docs rev: 44d2889a4f3fb5dfabb1ea4df68a1b8bbf9347c8)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12370]
All of the information from the "usingpoky" chapter in the
ref-manual has been distributed out over the rest of the
YP manual set. Primarily, this information went into the
dev-manual and the overview-manual. Because the chapter is
no more, I had to update the mega-manual.xml to not include that
chapter. Also, had to update ref-manual to exclude the chapter
as part of the Make process.
(From yocto-docs rev: b988cab06d42f0ac2220cefe66949c5ab6cbf803)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12370]
The section in the ref-manual on build history has been moved to
the dev-manual. It is more of a "how-to" piece of information than
a reference.
(From yocto-docs rev: 9634bd8dc51e2972e6a5f3a3d3b4256c8ca8749c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12370]
The QEMU information in the ref-manual "using" chapter has been moved
to the dev-manual's chapter 5, which is a dedicated QEMU chapter.
Some information is reference and that is why I had it separated out
into the reference manual. However, pressures are mounting to get
that stuff out of the ref-manual and into the dev-manual. So, it
has been moved.
(From yocto-docs rev: 69098ad83b10fab341ec3d5532e377dcfbbfc05e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12370]
Moved the debug information from the ref-manual to the dev-manual
where other debug information exists. We now have a single area
(section) that deals with various debugging techniques and tips.
(From yocto-docs rev: 95394197fc04981bf7571e581ff8a0fd9c76223f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12370]
The section in the ref-manual that overviewed the buld process was
redundant and more of a "how-to" topic. I have moved and merged it
into the dev-manual into a similar area.
(From yocto-docs rev: 44f1351334342629aaa0976f62e64ac4f67166aa)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
