This starts documenting the Yocto Project Compatible badging programme. This
adds an initial piece of documentation about it from which we can improve
as needed.
(From yocto-docs rev: baa70e3d0d6100e091eb78cf465a9734068a44e7)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
(From yocto-docs rev: e9921b746a0b2a4a2192bab224d9afa9d9395e1e)
Signed-off-by: Daniel Wagenknecht <dwagenknecht@emlix.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
DEPLOY_DIR_IMAGE has been replaced by IMGDEPLOYDIR for most use cases
since OE-Core rev 6d969bacc718e21a5246d4da9bf9639dcae29b02. Document
IMGDEPLOYDIR and add a note to DEPLOY_DIR_IMAGE about it.
(From yocto-docs rev: dad7046f9428bde476d2241209c118d52529bed5)
Signed-off-by: Daniel Wagenknecht <dwagenknecht@emlix.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
DEPLOY_DIR_IMAGE has been replaced by IMGDEPLOYDIR for most use cases
since OE-Core rev 6d969bacc718e21a5246d4da9bf9639dcae29b02. Update
examples given in the documentation to use IMGDEPLOYDIR and match their
implementation.
(From yocto-docs rev: 6cad5984306ffbf748a888cedc1a5015105e89fa)
Signed-off-by: Daniel Wagenknecht <dwagenknecht@emlix.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This makes the reference manual much lighter by moving
the migration guides to a separate document.
The migration guides are also reordered from last to first,
and they appear directly in the left bar, making them easier
to find in the documentation.
(From yocto-docs rev: 5121b86ee97eb62a0c69c9ad1fc0e3fabbe3e934)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Needed now that warnings are turned into errors
(From yocto-docs rev: 3f99cff8c6c672967eb09f6950d16ed30260ca68)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-W is for turning warnings into errors, --keep-going to make sure the
whole documentation is built and all warnings will be printed before
failing.
Since there's currently no warning, it's time to introduce it!
(From yocto-docs rev: 5d7b8547549b2203a03df617cdba70ccf2194c62)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The clutter class and image have been moved to meta-gnome before it
is finally obsoleted for good, so remove mentions from the documentation.
(From yocto-docs rev: adab5d0047354b5a1b11c2ece48abd8f295f69b0)
Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The automated script used back then didn't take into account that
terms could be lowercase which is the case for module_autoload and
module_conf, so let's add a link to those too.
Fixes: 9e468274eaad "docs: ref-manual: ref-variables: add links to terms in glossary"
(From yocto-docs rev: beeaf0c48dcd79626c1591a68da4b13387aa0c3f)
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>
This variable has been removed in July 2019 with commit
5deaa5df730a "runqueue: Drop unused BB_SETSCENE_VERIFY_FUNCTION2" in
bitbake git repo.
The glossary entry for the variable has been recently removed from bitbake
documentation, therefore the ref breaks the build.
Let's remove the reference so that the build still passes.
(From yocto-docs rev: 4db673a559d290547d4d6006ea692becb574deb7)
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>
(From yocto-docs rev: 6ed8e747265df899d8ce464d83281b0e0f04f9b2)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Keep the links in the left side navigation bar, but remove them from
the main page.
(From yocto-docs rev: d01324cfb6ecada22005ca05db99b0c1f75eb22e)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Tested-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The 'megamanuel' can be selected using the drop down menu on the
documentation website. It was reported it is confusing to have it on
the main page (and in the left side bar) as well. Let's remove it.
(From yocto-docs rev: 593898dc4a4695395856ea481b58cc5092ed3263)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Tested-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: c3e8eb234c9d1cf67dc46666ea26c1e4eb945c2c)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Adding 3.1.8 to documentation switcher and release list.
(From yocto-docs rev: 657408bf30279b44f1e1255787a2c56b739df142)
Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Adding 3.3.1 to documentation switcher and release list.
(From yocto-docs rev: db80bb70d9bea7008cb6b2795c8f617b1486ca03)
Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add some links to a small set of glossary variables that I happened
to be perusing at the time.
(From yocto-docs rev: d71d8da78285f2314bfd27a821b26434e39622a8)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
[ Yocto #14188]
The following packages where needed to a fresh FC33 install
perl-FindBin
perl-File-Compare
perl-File-Copy
perl-locale
Error seen:
openssl-native-1.1.1g-r0 do_configure: Execution of '/{snipped}/build/tmp-glibc/work/x86_64-linux/openssl-native/1.1.1g-r0/temp/run.do_configure.14627' failed with exit code 2:
Can't locate FindBin.pm in @INC (you may need to install the FindBin module)
(From yocto-docs rev: 5b4127dd72a465ff8c962c425e78140ca8e536db)
Signed-off-by: Armin Kuster <akuster808@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Adding 3.2.4 to documentation switcher and release list.
(From yocto-docs rev: b24cddff0f1367360441e3f9ff59cbed77da28ad)
Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: 784d39fe28436302b4df7e1ea08582d4d2f664c6)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Since LSB does not seem to be relevant these days, delete mentions of
it.
(From yocto-docs rev: 5b4354e0611253b40ad58613b910b6591493a1b4)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Minutiae including grammar fixes, increased brevity and adding a
proper link to another SDK manual section.
(From yocto-docs rev: 21d6c6fcbae938c256da6e72d6ac8d2ca72d5bc0)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
One grammar fix, and adding two proper links to other sections.
(From yocto-docs rev: 969d4737da992e1fbca14cfbeb35bd5401698cba)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
And add proper quoting around the first instance
of the "image" word, as it refers to a keyword in the
subsequent command.
(From yocto-docs rev: 1ffaa1db5a6eba53558b714f6071ea2e9bfe03e6)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Update Docker installation URL on various plaforms, replacing
some URLs by the ones they now redirect to, renaming "Docker CE"
to "Docker Desktop" on Mac and Windows, and to "Docker Engine"
on GNU/Linux.
Stop mentioning "Docker Toolbox" which is now deprecated and
replaced by "Docker Desktop" on Mac and Windows.
(From yocto-docs rev: 8eb249aed50b7b5b2078648c9efd9c79262ae57f)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: 29d8b6f07dddba43cf14706ec26cc8cf033d1040)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
Fix a misaligned code insertion statement, causing
the code block to be misaligned compared to the other ones
in subsequent paragraphs
(From yocto-docs rev: bc03d122a35ac027d0aab5bfd70b366933fd7356)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Adding Hardknott to documentation switcher and release list.
(From yocto-docs rev: d1578f6ae84d0c44c63632bd5f3146653f1310a3)
Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
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>
There was an en dash here instead of a hyphen; this meant that the
command line could not be copied and pasted verbatim. (Admittedly that
is less likely here than in other examples, but let's correct it
anyway.)
(From yocto-docs rev: 4f289752fab3529516ad44e6e62a1042c339fd13)
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>
The top level index file includes a link to the Bitbake
documentation. This link is static, however the location of the
Bitbake documentation depends on the intersphinx configuration. As
such, when looking at an old YP docs release, the link to the bitbake
documentation is always the same (and wrong).
Since we cannot use a cross reference in a toc index, this patch
creates an intermediate page for bitbake documentation, and in that
page we insert the right link to the bibtake documentation
(e.g. :doc:`bitbake:index`) which will be adjusted dynamically based
on intersphinx config.
(From yocto-docs rev: 4f7f451df266a307b34bf145b29291ca85eb882f)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Tested-by: Michael Opdenacker <michael.opdenacker@bootlin.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>
- A few style improvements
- Fix a few typos
(From yocto-docs rev: 116484a850bdd9b8b648d919fd9c8858f6c55e21)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Ubuntu has changed packaging and git-core is not available anymore,
it is now just plain git.
$ sudo apt-get install git-core
[sudo] password for jankii01:
Reading package lists... Done
Building dependency tree
Reading state information... Done
Note, selecting 'git' instead of 'git-core'
git is already the newest version (1:2.17.1-1ubuntu0.8).
The following package was automatically installed and is no longer required:
linux-hwe-5.4-headers-5.4.0-65
Use 'sudo apt autoremove' to remove it.
0 upgraded, 0 newly installed, 0 to remove and 13 not upgraded.
Documentation should match the current package name to avoid confusion/warnings.
Change can be verified by running the following script
set -ex
distros=("debian:8" "debian:9" "debian:10" "ubuntu:16.04" "ubuntu:18.04" "ubuntu:20.04")
for i in "${distros[@]}"
do
folder="${i/:/.}" # change : to .
mkdir -p $folder
cd $folder
echo FROM $i > Dockerfile
echo RUN apt-get update \&\& apt-get install -y git >> Dockerfile
echo
cat Dockerfile
docker build -t test-$folder .
cd ..
rm $folder/Dockerfile
rmdir $folder
done
(From yocto-docs rev: 8cf3acb3b639ef0373c2f77daf0a4323a7f404b0)
Signed-off-by: Janne Kiiskila <janne.kiiskila@pelion.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Add guidelines for choosing a release
- Check-out a branch instead of a fixed tag
This way it's possible to pull release updates later
(From yocto-docs rev: 00b45fcf7e37616b46ca003b49c83594c061c40b)
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>
None of the other distributions install compilers for 32-bit compilation,
and this package isn't available on arm64 Ubuntu systems.
(From yocto-docs rev: 5036fea7854c3152a0c148d8ab1668e01b38697d)
Signed-off-by: Ross Burton <ross.burton@arm.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This was accidentally missed in the last release update, fix it.
(From yocto-docs rev: 8a671976818381d97ae01499e9d7deb571312f7d)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
- Minor style and spelling fixes
- Add some extra details; add missing external link macros
and explain where they are defined
- Correct where documentation can be found on the
Yocto Project website: the "Documentation" tab
has been replaced by "Docs" (and it's later
shown as uppercase ("DOCS") by the current CSS, but this
may change one day.
(From yocto-docs rev: ed7b4f318c9ba6cf501f1e551c7a8eb4aaee1396)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
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>
Building with a outdated version of Sphinx print warnings that does not
appear on up-to-date sphinx.
This patch prevent building the documentation with any version older
than 3.1 (First version to build without warnings in my tests)
See threads "documentation: Add a simple Sphinx extension to check its version"
https://lists.yoctoproject.org/g/docs/topic/patch_documentation_add_a/79919516
and "toaster-manual: Fix a warning related to the code-block directive"
https://lists.yoctoproject.org/g/docs/topic/patch_toaster_manual_fix_a/79656195
(From yocto-docs rev: 4de0f3dd4d5df0a0700f704a599bb41726d15a5f)
Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
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>
