Particularly,
- correctly describe the use of DEBUGINFOD_URLS; drop it from bitbake variables
- all necessary component tweaks are enabled by default via DISTRO_FEATURES
- provide on-target examples of what to look for when things work properly
(From yocto-docs rev: 6d5d568d427b22675b999f94ead829ab1bef0b21)
Signed-off-by: Alexander Kanavin <alex.kanavin@gmail.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
See [YOCTO #13921]
Add details to the SERIAL_CONSOLES_CHECK entry to clarify that it
doesn't work with read-only rootfs.
(From yocto-docs rev: cefd66301a40f9048499879674e467543f704c44)
Signed-off-by: Trevor Gamblin <trevor.gamblin@windriver.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This simplifies paragraphs ending with a colon and followed
by code insertion.
Automatically substituted through the command:
sed -i -z "s/:\n\s*::/::/g" file.rst
This generates identical HTML output.
(From yocto-docs rev: 28e2192a7c12d64b68061138a9f6c796453eebb1)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This replaces instances of ": ::" by "::", which
generates identical HTML output
(From yocto-docs rev: 1f410dfc7c16c09af612de659f8574ef6cff4636)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add a variable glossary entry and corresponding 3.3 migration
section entry for DISTUTILS_SETUP_PATH.
(From yocto-docs rev: 0823237e6f4b9dbdf48500b3c1e8cc61696fa2d2)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
People will see release codenames in other contexts, and thus it is
useful to mention them explicitly here rather than having to go to the
Releases wiki page to map version number to release codename.
(From yocto-docs rev: fe3a91e8b3ef09b79711b62c6a08643f9444dcec)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add a joining paragraph and fix the second section so that it makes
sense with the addition of the first one.
(From yocto-docs rev: 8ee993995d9d72873f36e40dda5e3f345901978c)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This has been here since the text was added to the DocBook version.
(From yocto-docs rev: 611588b065ab98d7021173525027d16b5ab519c8)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add FIT_KERNEL_COMP_ALG and FIT_KERNEL_COMP_ALG_EXTENSION. Examining
OE-Core commit 5c72105e2973e613b5c0f0e6310ffdea6e56c6c7 and the
associated code, these do not enable arbitrary selection of compression
algorithm - only disabling compression - so document them accordingly.
(From yocto-docs rev: 41640526dd87153fdf802b058336c6fb466b8ade)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add a reference to the recently added passwd-expire command in
EXTRA_USERS_PARAMS.
(From yocto-docs rev: 9a6c8b37a1e6baab4dfb2ffe7b4abdf7dcbb8822)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add the recently added python3targetconfig class. Also, we no longer
have the python 2 classes, remove all references to those.
(From yocto-docs rev: c63d88656e2fc5361c512d4d9b426260c3e339f3)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add REQUIRED_VERSION, add a reference to it in PREFERRED_VERSION and
adjust the opening statement to read slightly better.
(From yocto-docs rev: c1c0b3600f2f6e752faacfc877b80c2dda7cf522)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
DISTRO_VERSION snapshot versions use METADATA_REVISION not DATE in
hardknott and thus the default for SDK_VERSION has been updated, so
update it here as well. Additionally, fix the text so it makes sense.
(From yocto-docs rev: 7b0c4229591d6325384800137e9242c2b030e118)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Minimum Git, tar, Python and gcc versions are specified in quite a few
different places. Let's add some variables for these so there's no
chance of missing one if they're updated in future. Additionally, for
hardknott the minimum Python version is 3.6 so set that as the value for
Python.
(From yocto-docs rev: 9a802bc4bb0438c2540f360a08c7787caf64408a)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These are not new variables, but we are using METADATA_REVISION in a new
place and thus need to refer to it.
(From yocto-docs rev: 3b80ece864e8cc06f09d3d4ee645ddeef5d4eaf6)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Anchor links are treated by Sphinx as external links and are not checked
during build, meaning it is impossible to know if a link becomes broken or
not.
As a matter of fact, most of the anchor links replaced in this commit
were actually broken.
The README now states that anchor links are forbidden so that there's no
need to go through such a change later on.
(From yocto-docs rev: de9e4d26b46afa3c79137d07529a74553400d2e0)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- That could originate from documentation migration issues
- Checked that the corresponding links still exist
(From yocto-docs rev: 38bae8f6067bc12f3617ed38587737d22dd7b32c)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Spelling fixes found using Emacs' spelling checker
configured for US English
- Fixes for some capitalization issues, especially some
project names (QEMU, openSUSE, BusyBox), that were not
consistently used with the same capitalization anyway.
- A few whitespace fixes too
(From yocto-docs rev: 05d69f17490dcc4933dcd85e57d9db53b912084a)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added documentation on running debuginfod server and using it on the target.
Added the term DEBUGINFOD_URLS definition in ref-manual/variables.rst
(From yocto-docs rev: a16ae140e26482c81ce733f20f8c68c6eba55f35)
Signed-off-by: Dorinda Bassey <dorindabassey@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the "Yocto Project Quick Build" instructions
(https://docs.yoctoproject.org/brief-yoctoprojectqs/index.html#)
there is an inconsistency that impacts several documents...
People are first instructed to clone the poky git repository, but not
mentioning from which directory. Then, it's consistent to instruct
people to run "cd poky/".
However, later in the instructions, readers are instructed to run "cd
~/poky", which assumes that cloning poky was done from the home
directory. Many other places in the documentation make such an assumption.
This change fixes this, and makes no assumption on where people
have chosen to store their data, in particular where they cloned
the "poky" repository.
This also fixes a few whitespace issues.
(From yocto-docs rev: fd4e365c85df212d7ed70fc1abb3657a4a88b294)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Not sure what those leading '\*' are doing, but they're rendered
verbatim and mess up creating a linkable item.
(From yocto-docs rev: dd2e5ef733f056900cc4c9746a1e8c688cc61920)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updates the documentation for PROVIDES so that it recommends "+="
instead of "=".
(From yocto-docs rev: 39b2ca1e27592488d396d5f0d76965f0006515a1)
Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit adds the description of the Initramfs bundle and boot script
new features implemented in the kernel-fitimage class.
Change-Id: Ifffa6b850308aa7ceadc4f117806cffad0137137
(From yocto-docs rev: a55c16555366c0adbf4a087b86574b07972cbc52)
Signed-off-by: Abdellatif El Khlifi <abdellatif.elkhlifi@arm.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
poky.yaml references are only replaced in files if they are prefixed by
& and suffixed by ;.
Let's fix the missing surrounding characters.
(From yocto-docs rev: 7ee4ba7a27acd87d8c728639d1b053d2e26c6e58)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
When extracting the tarball the root folder is not named `poky`, but
e.g. `poky-gatesgarth-24.0.0`.
(From yocto-docs rev: 8c92f709cbd96310b7153dd55dae8fa4899a7818)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Change all instances of U-boot to U-Boot.
(From yocto-docs rev: 153c60fd9f2807c8e98105bcd4384e52e2adaa1a)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Make it clear that KERNEL_ALT_IMAGETYPE is intended to allow building an
additional image type.
(From yocto-docs rev: d2f51d310028dfa50584f7dc04ea3627d14d3f1e)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Minor syntax and formatting corrections.
(From yocto-docs rev: eda1fae0dc8670ff22f10b591ce14b9bbf0455ce)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
All filenames duplicate the 'manual name', which is not needed, and
make all references longer than they should. Rename all files to be as
consise as possible, and fix all references
(From yocto-docs rev: bb7e4783f45a5f67e6e4b39968f3512f43738833)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
All filenames duplicate the 'manual name', which is not needed, and
make all references longer than they should. Rename all files to be as
consise as possible, and fix all references
(From yocto-docs rev: bd8c0f7fc09a39a8bbde1c05b51693955738e148)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
All filenames duplicate the 'manual name', which is not needed, and
make all references longer than they should. Rename all files to be as
consise as possible, and fix all references
(From yocto-docs rev: 4f489a40bb00be018e419802a76fec9dbee3f255)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
All filenames duplicate the 'manual name', which is not needed, and
make all references longer than they should. Rename all files to be as
consise as possible, and fix all references
(From yocto-docs rev: 3d7eb2c5e1d230290c97dd8e5b528086e1d8034a)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
All filenames duplicate the 'manual name', which is not needed, and
make all references longer than they should. Rename all files to be as
consise as possible, and fix all references
(From yocto-docs rev: 00a9244587e2e63f2a5197ed0dfc89cb330f9275)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
All filenames duplicate the 'manual name', which is not needed, and
make all references longer than they should. Rename all files to be as
consise as possible, and fix all references
(From yocto-docs rev: b5a1a504caf7ffcaeca787b38bf7f11e341dfb0f)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
:doc: references can be made with absolute path instead of relative
path. This patch was generated with this command:
sed -i 's!:doc:`\.\./!:doc:`/!g' */*.rst *.rst
And a few manual fixup we made for references such as:
:doc:"FOOBAR <../xxx>"
Suggested-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: b7948ec7eb8172b8eae4bfa5c21aab76e123ad85)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
It is more common to call the top level document index.rst. This is
what this patch is doing, along with all required references fixup.
(From yocto-docs rev: 2cea7fbba9210479fc0387d7e1b80da9885558f0)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Manual links to git.openembedded.org are converted to use the oe_git
directive where possible. Note that this directive can't be used in some
places such as example code.
(From yocto-docs rev: 64d2b5c26889356d4eb49896566cf28b9234b9cc)
Signed-off-by: Paul Barker <pbarker@konsulko.com>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The yocto_git external link directive is modified to include the
`/cgit/cgit.cgi` element of the URL so that we can simplify the links in
the text.
Manual links to git.yoctoproject.org are converted to use the yocto_git
directive where possible. Note that this directive can't be used in some
places such as example code.
(From yocto-docs rev: 3a8ba5dcc783411c73fe49fb217cbc4d6528d9a7)
Signed-off-by: Paul Barker <pbarker@konsulko.com>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The `yocto_wiki` external link directive is modified to include the
`/wiki` element of the URL so that we can simplify the links in the
text.
Note that there are still a couple of places where this directive
cannot be used, such as in the table of contents in index.rst.
(From yocto-docs rev: d8aa5f93d349f27db3d03a2c4bcc205649f45a8d)
Signed-off-by: Paul Barker <pbarker@konsulko.com>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In order to remove autogenerated labels in the bibtake docs, let's use
section titles in all YP docs.
(From yocto-docs rev: 0f44b6027f16cc37260abc7e00042d98e2e0427f)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fix single misspelling.
(From yocto-docs rev: e1a47857f4ff3edb105e7fa80ff8d29dcc3ece03)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add a migration subsection on the need to add MLPREFIX to conditional
package dependencies in gatesgarth.
(From yocto-docs rev: e202beabfc1282d6999fde0ced89e41c993da27f)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add some info on the image-artifact-names class change in gatesgarth.
(From yocto-docs rev: 71dd9d92bf58c73f5fb3bd14cf8031bfc794fd3f)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
