summaryrefslogtreecommitdiffstats
path: root/documentation
AgeCommit message (Collapse)Author
2021-05-17documentation: prepare for 3.3.1 releaseyocto-3.3.1hardknott-3.3.1Richard Purdie
Include update to previous releases. (From yocto-docs rev: eb19a2b5687f11c22c7fc26d3efabbf65adb572e) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15ref-manual: add mention of DISTUTILS_SETUP_PATHPaul Eggleton
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>
2021-04-15ref-manual: migration guide: add release codenamesPaul Eggleton
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>
2021-04-15ref-manual: add migration section for 3.3 releasePaul Eggleton
(From yocto-docs rev: b8b6e8335be382337fe4adda11d5a90872ff4c79) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15ref-manual: tweak buildtools sectionPaul Eggleton
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>
2021-04-15ref-manual: fix reference to build-essentialPaul Eggleton
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>
2021-04-15ref-manual: add FIT_KERNEL_COMP_ALG*Paul Eggleton
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>
2021-04-15ref-manual: add passwd-expire to EXTRA_USERS_PARAMSPaul Eggleton
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>
2021-04-15ref-manual: add python3targetconfig class and remove python 2 referencesPaul Eggleton
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>
2021-04-15ref-manual: add REQUIRED_VERSION and adjust PREFERRED_VERSION entryPaul Eggleton
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>
2021-04-15ref-manual: and SDK_CUSTOM_TEMPLATECONF to glossaryPaul Eggleton
(From yocto-docs rev: dc23e9cf8fa161388a52deae5e6c9da54c6573d5) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-15overview-manual: fix git command linePaul Eggleton
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>
2021-04-15ref-manual: update/fix text for SDK_VERSIONPaul Eggleton
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>
2021-04-15Use variables for minimum host versions and bump Python to 3.6Paul Eggleton
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>
2021-04-15ref-manual: add METADATA_REVISION and METADATA_BRANCHPaul Eggleton
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>
2021-04-09docs: add a top level page for bitbake documentationNicolas Dechesne
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>
2021-04-09docs: replace anchor linksQuentin Schulz
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>
2021-04-09sdk-manual: fix typoUlrich Ölmann
(From yocto-docs rev: 5bde446a0335ccf7f3d772e1eef666aeb31eace3) Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-06manuals: fix suspicious newlinesMichael Opdenacker
- 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>
2021-04-06ref-manual: fix typoMichael Opdenacker
- Fix an obvious typo (From yocto-docs rev: 03bbd66ddb85acddcfa0c588cfd29e2eac15d3db) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-06overview-manual: style improvementsMichael Opdenacker
- 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>
2021-04-06manuals: Fix typos and spacingMichael Opdenacker
Fix double words, punctuation spacing issues, spacing issues, "its" instead of "it's", and other trivial issues. (From yocto-docs rev: 56eb1f340a7af112e62c1d8ad02d4bec0ad88313) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-06poky.yaml: Use git instead of git-core for UbuntiJanne Kiiskila
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>
2021-04-06Quick build: checkout a branch instead of a fixed tagMichael Opdenacker
- 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>
2021-04-06SDK manual: fix reference to appendixMichael Opdenacker
Fixes [YOCTO #14307] (From yocto-docs rev: d14bdf401114054d517c09d483947705e2a0d71d) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-04-06manuals: Spellcheck and capitalization fixesMichael Opdenacker
- 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>
2021-04-06poky.yaml: change gcc-multilib to gccRoss Burton
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>
2021-04-06documentation/poky.yaml: Fix latest 3.2 series tag referenceRichard Purdie
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>
2021-04-06releases: update to include 3.2.3Michael Halstead
Updating to build 3.2.3 docs and add missing 3.0.4 release line. (From yocto-docs rev: 95972458c4c5ecea38676975f69afca7f0c91e35) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-03-23documentation/README minor improvementsMichael Opdenacker
- 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>
2021-03-23dev-manual/common-task.rst: Added documentation for debuginfod supportDorinda
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>
2021-03-23Update documentation URLMichael Opdenacker
(From yocto-docs rev: dcedeaeb50d094d278e114928bfb63164aa7afb2) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-03-23Do not assume working from $HOMEMichael Opdenacker
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>
2021-03-22ref-manual: remove erroneous '\*' from variables listRobert P. J. Day
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>
2021-03-11common-tasks.rst: fix typoUlrich Ölmann
(From yocto-docs rev: a66062216cccbe7350fdc3ee39544eeb515509ed) Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-03-11common-tasks.rst: fix 'wic cp' commandUlrich Ölmann
(From yocto-docs rev: 4d5a184b2bf5e73c036b82984be1a2dc4c8688b5) Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-03-11ref-manual: Add Az fetcher documentationAlejandro Hernandez Samaniego
(From yocto-docs rev: c4ad59cdc2c7fde6ef4698e5f47282540d8f0d8a) Signed-off-by: Alejandro Enedino Hernandez Samaniego <alhe@linux.microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-02-26releases: update to include 3.1.6Michael Halstead
(From yocto-docs rev: 05580e574e78039f577d58648b4ee3817c0f09cc) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-02-26releases: update to include 3.2.2Michael Halstead
(From yocto-docs rev: 1770c9c1e1ce9d28f6d211061010c4a802522c16) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-02-20figures/yp-how-it-works-new-diagram.png: Fix spelling error underlineRichard Purdie
(From yocto-docs rev: 16c598c123cf197ddd547458fc34dd72f1eee878) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-20releases: conf: add link to 3.1.5, update to include 3.2.1 & 3.1.53.3_M2Michael Halstead
(From yocto-docs rev: 5c94f8183733bf266cd6153434b5eed22d1914c6) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-20ref-manual: Clarify recommended operator for PROVIDESJoshua Watt
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>
2021-01-20documentation: Prevent building documentation with an outdated version of sphinxYoann Congal
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>
2021-01-20ref-manual/ref-classes: update kernel-fitimage with Initramfs bundle and ↵Abdellatif El Khlifi
boot script 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>
2021-01-20docs: fix missing & and ; surrounding references from poky.yamlQuentin Schulz
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>
2021-01-20dev-manual: Add usage of /sysroot-only in SYSROOT_DIRSDiego Sueiro
(From yocto-docs rev: adc59efc4a6c56cc3b4594a411ae618d256d6ba2) Signed-off-by: Diego Sueiro <diego.sueiro@arm.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-15common-tasks.rst: Fix GNU_HASH in hello.bbLeon Anavi
Fix the following GNU_HASH issue in "Single .c File Package (Hello World!)" example: ERROR: hello-1.0-r0 do_package_qa: QA Issue: File /usr/bin/helloworld in package hello doesn't have GNU_HASH (didn't pass LDFLAGS?) [ldflags] Reported-by: Matthew Tsenkov <matthew.tsenkov@konsulko.com> (From yocto-docs rev: 99a53f443193c0becd48a07a2dd740bb417dcf49) Signed-off-by: Leon Anavi <leon.anavi@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-15documentation: Fix a Concpets -> Concepts typoYoann Congal
(From yocto-docs rev: 78bdf1c25c5c546c35b5a0d246aa1bbd70d5eace) Signed-off-by: Yoann Congal <yoann.congal@smile.fr> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-05variables: Add documentation for KERNEL_DTC_FLAGSOvidiu Panait
Add documentation for the newly introduced KERNEL_DTC_FLAGS variable. (From yocto-docs rev: b2d5bf48fe4e76446a38762839865176294a4a3c) Signed-off-by: Ovidiu Panait <ovidiu.panait@windriver.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-04ref-manual: terms: Fix poky tarball root folderElvis Stansvik
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>
generated by cgit 1.2.3-korg (git 2.39.0) at 2024-05-01 05:24:57 +0000