summaryrefslogtreecommitdiffstats
path: root/documentation/poky.yaml
Commit message (Collapse)AuthorAgeFilesLines
* Makefile/set_versions: Allow poky.yaml to be autogeneratedRichard Purdie2022-03-231-45/+0
| | | | | | | | | | | Use a script to generate the branch/tag information inside poky.yaml. If the branch isn't a known release branch, include git magic to find the closest matching release branch we know about. (From yocto-docs rev: 841e2df0e2e544b82fff9ddd0339a4e775148e3a) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.yaml: Drop unused YOCTO_DOC_VERSION_MINUS_ONERichard Purdie2022-03-211-1/+0
| | | | | | | | | | | This doesn't seem to be used anymore and doesn't make much sense, remove it. (From yocto-docs rev: 89176e0bd45453ebb7ac77ce6fa333cb94f0cfcc) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.yaml: Drop POKYVERSION and YOCTO_POKY referencesRichard Purdie2022-03-211-2/+0
| | | | | | | | | | | | | | We don't publish tarballs using this version any more, it has been removed everywhere. Remove the obsolete references in the docs, adapting references accordingly. The tarballs now are just created with their sha256 checksum which we don't want or need to reference in the docs. (From yocto-docs rev: c7a0ac88b01c48f3d9209536542bf43ae7a7937f) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* releases: update to include 3.3.5Michael Halstead2022-03-031-1/+1
| | | | | | | | | Adding 3.3.5 to documentation switcher and release list. (From yocto-docs rev: 78545b8f42657c21bc3cac96429d3950b07a3aca) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* releases: update to include 3.4.2Michael Halstead2022-02-211-4/+4
| | | | | | | | | Adding 3.4.2 to documentation switcher and release list. (From yocto-docs rev: 6ffc51362a8fd028429359eb9da57c87b270584d) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.yaml: centos-7 python36-pip -> python3-pipTim Orling2022-01-101-1/+1
| | | | | | | | | | | | | | In CENTOS7_HOST_PACKAGES_ESSENTIAL, change python36-pip to python3-pip. The python36-pip package was obsoleted by python3-pip in RHEL 7.7+ https://src.fedoraproject.org/rpms/python-pip/c/6771a1c54f5c7ac333c7af644c055da670027f6c?branch=epel7 (From yocto-docs rev: df5d499f86e0cf2b6316778c7c390d64f5f1367c) Signed-off-by: Tim Orling <tim.orling@konsulko.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* releases: update to include 3.4.1Michael Halstead2021-12-121-4/+4
| | | | | | | | | Adding 3.4.1 to documentation switcher and release list. (From yocto-docs rev: 7d503d765f5a8ade226c897a17aecd0856104af1) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* releases: update to include 3.3.4Michael Halstead2021-11-191-1/+1
| | | | | | | | | Adding 3.3.4 to documentation switcher and release list. (From yocto-docs rev: 468e8bfb4b9bed662f1b32b0563339d0816a7e98) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: poky.yaml: updates for 3.4Michael Opdenacker2021-10-221-8/+8
| | | | | | | (From yocto-docs rev: d080c62f3ec489275b2f241ccea51cf127f4f782) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.yaml: fix lz4 package name for older Ubuntu versionsPaul Eggleton2021-10-221-1/+1
| | | | | | | | | | | | | It turns out that for Ubuntu, lz4 is the valid package name for newer versions (e.g. 20.04 LTS) but not for older ones (e.g. 18.04 LTS, where the correct package is liblz4-tool). In 20.04 the lz4 package includes liblz4-tool in its "provides" so it's best to list that one for now. (From yocto-docs rev: 2a4e259d2786c14b19a632b3a8f1a06383b6a80c) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.yaml: add lz4 and zstd to essential host packagesPaul Eggleton2021-10-201-5/+6
| | | | | | | | | | These are now required so update the corresponding distro-specific lists used in the system requirements documentation. (From yocto-docs rev: 604deb5c30a8808a60187f81645fa08b67ef2de9) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* releases: update to include 3.3.3Michael Halstead2021-09-181-4/+4
| | | | | | | | | Adding 3.3.3 to documentation switcher and release list. (From yocto-docs rev: cc88f73ea0e38f536cb3e05b504df80048856a84) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* releases: update to include 3.3.1Michael Halstead2021-08-041-4/+4
| | | | | | | | | Adding 3.3.1 to documentation switcher and release list. (From yocto-docs rev: 3c98afb0fefd889e8036639d9a2c775b73b237c2) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* releases: update to include 3.3.1Michael Halstead2021-05-251-4/+4
| | | | | | | | | 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>
* poky.yaml: fedora33: add missing pkgsArmin Kuster2021-05-221-1/+2
| | | | | | | | | | | | | | | | | | | | | [ 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>
* releases: update to include 3.2.4Michael Halstead2021-05-181-1/+1
| | | | | | | | | 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>
* releases: update to include 3.3Michael Halstead2021-04-201-8/+8
| | | | | | | | | 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>
* Use variables for minimum host versions and bump Python to 3.6Paul Eggleton2021-04-151-0/+4
| | | | | | | | | | | | | 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>
* poky.yaml: Use git instead of git-core for UbuntiJanne Kiiskila2021-04-061-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* poky.yaml: change gcc-multilib to gccRoss Burton2021-04-061-1/+1
| | | | | | | | | | 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>
* documentation/poky.yaml: Fix latest 3.2 series tag referenceRichard Purdie2021-04-061-1/+1
| | | | | | | | 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>
* releases: update to include 3.2.3Michael Halstead2021-04-061-3/+3
| | | | | | | | | 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>
* releases: update to include 3.1.6Michael Halstead2021-02-261-1/+1
| | | | | | | (From yocto-docs rev: 05580e574e78039f577d58648b4ee3817c0f09cc) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* releases: update to include 3.2.2Michael Halstead2021-02-261-4/+4
| | | | | | | (From yocto-docs rev: 1770c9c1e1ce9d28f6d211061010c4a802522c16) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* releases: conf: add link to 3.1.5, update to include 3.2.1 & 3.1.53.3_M2Michael Halstead2021-01-201-5/+5
| | | | | | | (From yocto-docs rev: 5c94f8183733bf266cd6153434b5eed22d1914c6) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* releases: conf: add link to 3.1.4, update to include 3.1.4Michael Halstead2020-12-031-1/+1
| | | | | | | (From yocto-docs rev: 20b7be912040ae02fb2df652fb79b09dd5f281e8) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.yaml: Define DISTRO_NAME_NO_CAP_LTSPaul Barker2020-11-241-0/+1
| | | | | | | | | | | This allows us to reference the branch name for the latest LTS release (currently dunfell) in the text. When the current release is an LTS, this variable will be equal to DISTRO_NAME_NO_CAP. (From yocto-docs rev: d5022ebbba31433761d84b1e5552dd86e08745d9) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.yaml: updates for 3.2Nicolas Dechesne2020-11-121-8/+8
| | | | | | | | | Updates global variables for 3.2 / Gategarth release. (From yocto-docs rev: 505d4551d47db03b47164321e4559023d9473e21) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.yaml: remove unused variablesNicolas Dechesne2020-11-121-47/+0
| | | | | | | | | | | | | | | There are plenty of variables in poky.yaml which are not used anywhere in the docs. So let's remove them. We can always add the one we need later. Note ORGEMAIL could be used in boilerplate.rst, however this file is not parsed but included, and somehow the yocto-vars.py exenstion does not process this file, so we cannot use a variable there. (From yocto-docs rev: f1164d2e6401d93e0b4e484b090abbe0f72a6ac7) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual: delete obsolete ADT manual, and related contentRobert P. J. Day2020-10-301-1/+0
| | | | | | | | | | | | Since the ADT manual has long been superseded by the SDK manual, remove the entire adt-manual directory, and the references to it in the two top-level files "conf.py" and "poky.yaml". (From yocto-docs rev: 64b2e83bddf6af0439ac7089ac95e60faa696cfc) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: poky.yaml: fix identation in host packages variablesQuentin Schulz2020-10-201-7/+7
| | | | | | | | | | This unfortunately makes the variables probably unusable for proper replacement in other indentation blocks. (From yocto-docs rev: adf240b8db9597328324bbfb0095f573bea217f9) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: ref-manual: ref-system-requirements: update requirements to build ↵Quentin Schulz2020-10-201-0/+1
| | | | | | | | | | | | | | | | | | | | | | Sphinx docs 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>
* docs: remove OE_INIT_FILE variableQuentin Schulz2020-10-201-1/+0
| | | | | | | | | | | | | | 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>
* docs: poky.yaml: use HTTPS for linksQuentin Schulz2020-10-201-9/+9
| | | | | | | | | | Manually tested, ran linkcheck on it too. Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> (From yocto-docs rev: 46912c4c7e429f01dba52071efa649e8c4fbaf06) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx: conf: add substitutions/global variablesNicolas Dechesne2020-09-171-0/+89
The Yocto Project documentation makes heavy use of 'global' variables. In Docbook these 'variables' are stored in the file poky.ent. This Docbook feature is not handled automatically with Pandoc. Sphinx has builtin support for substitutions however they are local to each reST file by default. They can be made global by using rst_prolog: rst_prolog A string of reStructuredText that will be included at the beginning of every source file that is read. However Sphinx substitution feature has several important limitations. For example, substitution does not work in code-block section. yocto-vars.py is an extension that processes .rst file to find and replace 'variables'. This plugin will do variables substitutions whenever a rst file is read, so it happens before sphinx parses the content. All variables are set in poky.yaml. It's a simple YAML file with pairs of variable/value, and the file is parsed once during setup. It's important to note that variables can reference other variables. poky.yaml was generated by converting poky.ent into a YAML format. To use a variable in the Yocto Project .rst files, make sure it is defined in poky.yaml, and then you can use : &DISTRO_NAME; For external links, Sphinx has a specific extension called extlinks, let's use it instead of variable substituions. Note that we intentionnally did not put the trailing '/' in the URL, this is to allow us to use :yocto_git:`/` trick to get the actual URL displayed in the HTML. (From yocto-docs rev: dc5f53fae8fdfdda04285869dd1419107b920bfe) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>