summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/system-requirements.rst
Commit message (Collapse)AuthorAgeFilesLines
* system-requirements: update list of supported distrosAntonin Godard2024-12-161-14/+6
| | | | | | | | | To match the list in meta-poky/conf/distro/poky.conf. (From yocto-docs rev: 802677ea3ef7b6c1ed43c71f7f33489288c0735a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* Gather dependencies in poky.yaml.inAntonin Godard2024-12-161-9/+13
| | | | | | | | | | | | | | | | | | | We used to have packages here and there in system-requirements.rst for each distro. Instead, gather all the dependencies in poky.yaml.in so we have an overview of what we provide for each distro. Use yaml ">" to list the dependencies in alphabetical order, one entry per line, which makes them easier to read and compare among distros. Rename UBUNTU_… variables to UBUNTU_DEBIAN_…, since these are used for both distros. (From yocto-docs rev: 580b410c535f3b24f901cdbf011bf817038ba4c3) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 1ed6118b7cf1b5dcbfca753c83fa30fb97bf44ad) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: use standardized method accross both ubuntu and debian for ↵Guénaël Muller2024-12-161-0/+17
| | | | | | | | | | | | | | | | | | locale install Modify locale installation method to be standard accross all debian-based distributions. Pre-existing method is available only on Ubuntu, locale-gen tool has no parameter in Debian. (From yocto-docs rev: 057f2fbce22fc020bef7d432275e28227895e022) Signed-off-by: Guénaël Muller <guenael.muller@smile.fr> Reviewed-by: Yoann Congal <yoann.congal@smile.fr> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Tested-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 30002019198a168e48537407bb928facb26af82a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: system-requirements: remove outdated noteMichael Opdenacker2024-03-011-6/+0
| | | | | | | | | To align this document with the version in the master branch (From yocto-docs rev: 08ce7db2aa3a38deb8f5aa59bafc78542986babb) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: system-requirements.rst: fix AlmaLinux variable nameMichael Opdenacker2024-03-011-1/+1
| | | | | | | (From yocto-docs rev: fb0fa6e06df46be6b4e35e5a83252277abcd64d7) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: system-requirements: update packages to build docsMichael Opdenacker2024-03-011-5/+5
| | | | | | | | | | | | | | | | - "git" is now required to run "set_versions.py" - Fix Ubuntu / Debian packages. The previous instructions didn't run on Debian 12 Tested on Ubuntu 22.04 and Debian 12. Reported on https://lists.yoctoproject.org/g/docs/message/4789 (From yocto-docs rev: f2a4799fa1cb6ea406d97e1b47ce888e7f5dd264) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: <mhagans@skyviewsat.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: system-requirements.rst: simplify supported distro requirementsMichael Opdenacker2024-03-011-84/+36
| | | | | | | | | | | | | | | | | | - This allows to continue sharing the updated Ubuntu/Debian requirements with the brief-yoctoprojectqs/index.rst without indentation mismatches (caused by using the same macro in two different contexts: in direct text and in a bullet list). - Update poky.yaml.in to adapt the number of spaces at the beginning of lines. - brief-yoctoprojectqs/index.rst: fix bad number of spaces before quote block. (From yocto-docs rev: 488731c09bf63fadc02ddcdd94fb3374dafce528) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: updates for building on Windows (WSL 2)Michael Opdenacker2024-03-011-5/+5
| | | | | | | | | | | | | - Use the Wikipedia naming scheme: WSL 2 instead of WSLv2 - Take into account Windows Server 2019 and 2022 which are supported too. - Improve some explanations (From yocto-docs rev: e64c1154c358128d76b1b8e3a5809dbaa8dc6881) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/system-requirements.rst: recommend buildtools for not supported ↵Michael Opdenacker2024-03-011-1/+7
| | | | | | | | | | | | distros Also minor correction to supported distribution notes (From yocto-docs rev: cb417cef74b87b53300eb05c21675b5e24a10ca7) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Alexander Kanavin <alex.kanavin@gmail.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: system-requirements: modify anchorMichael Opdenacker2024-03-011-1/+1
| | | | | | | | | To align with the "master" branch (From yocto-docs rev: aaeb061fa8ff73496175eba59f53a19fdcf08f64) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: update references to buildtoolsMichael Opdenacker2024-03-011-46/+41
| | | | | | | | | Also fix number of corresponding paragraphs (From yocto-docs rev: 28ee2d91fe4dd0549940dc5df1ff1d59363fcc0f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: add info on buildtools-make-tarballPaul Eggleton2024-03-011-1/+25
| | | | | | | | | | | | | PENDING ON THIS OE-CORE PATCH: install-buildtools: support buildtools-make-tarball and update to 4.1 https://lists.openembedded.org/g/openembedded-core/message/171522 Cover the use case and the new provided tarball. (From yocto-docs rev: 824c075c31650b9b466ac54fdf926043927b7045) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: add minimum RAM requirementsMichael Opdenacker2024-03-011-0/+10
| | | | | | | | | | | | Measured by generating a "core-image-sato" image for a "qemux86-64" machine from an Ubuntu 22.04 VM with 4 cores. Less memory was not enough and caused Out of Memory failures. (From yocto-docs rev: 5009d3898a1649074d1fc252ed33ecbf3235ed75) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: update disk space requirementsMichael Opdenacker2024-03-011-0/+11
| | | | | | | | | | | Tests made on Poky master on March 16, 2023. Add a "Free Disk Space" section to the "System Requirements" document. (From yocto-docs rev: 6e88a53c47f15376c4eec8b34d14239dcf285da3) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: update tested and supported distrosMichael Opdenacker2024-01-101-11/+8
| | | | | | | | | | | | | | | | | | According to currently active workers https://autobuilder.yoctoproject.org/typhoon/#/workers and to the "workers_prev_releases" definition in https://git.yoctoproject.org/yocto-autobuilder2/tree/config.py Also correct the text saying that SANITY_TESTED_DISTROS lists currently tested distros. Also replace AlmaLinux 8.8 and 9.2 by just AlmaLinux 8 and 9, as we update our workers anyway. (From yocto-docs rev: 79a6ec6847cdfc40d75def36993a40fec853a7a1) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: add new contributor guideMichael Opdenacker2023-09-081-3/+2
| | | | | | | (From yocto-docs rev: 028a1b89fbb6ee7f02a7ca8cd481931e096d764b) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: system-requirements: update supported distrosMichael Opdenacker2023-09-081-8/+27
| | | | | | | | | | | | | | | | | | - Update according to changes in SANITY_TESTED_DISTROS (meta-poky/conf/distro/poky.conf) - No longer declare as "Supported" the distributions versions which are End of Life for their vendors, as some of them (Ubuntu for example) ship updates to subscribers only, which the Yocto Project has no access to. - List distribution versions which were previously tested for the branch of the Yocto Project being considered. (From yocto-docs rev: 84d7f2e2a218502b4af4fc2e7de1761e489f86f4) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* system-requirements.rst: add Fedora 36 and AlmaLinux 8.7 to list of ↵Steve Sakoman2023-02-231-0/+4
| | | | | | | | | | supported distros (From yocto-docs rev: 0a1257860ed41d526856dc71b36e7f96155c0844) Signed-off-by: Steve Sakoman <steve@sakoman.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* system-requirements.rst: Add Ubuntu 22.04 to list of supported distrosSteve Sakoman2022-09-161-0/+2
| | | | | | | (From yocto-docs rev: f632dad24c39778f948014029e74db3c871d9d21) Signed-off-by: Steve Sakoman <steve@sakoman.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: ref-system-requirements.rst: update list of supported distrosMichael Opdenacker2022-03-161-6/+4
| | | | | | | | | | | | | | | Add AlmaLinux 8.5, Fedora 35, and OpenSUSE Leap 15.3 Remove Fedora 33, Debian 8, OpenSUSE Leap 15.1 and 15.2 Removing distros that were recently removed from SANITY_TESTED_DISTROS in meta-poky/conf/distro/poky.conf (From yocto-docs rev: 734d5db1f166d7722541b25718fb11a12282f0c5) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Steve Sakoman <steve@sakoman.com> Reported-by: Christian Eggers <ceggers@arri.de> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: fix hardcoded link warning messagesQuentin Schulz2022-02-231-1/+1
| | | | | | | | | | | | | | Sphinx complains about hardcoded links which can be replaced by an extlink. So let's apply its recommendations. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: dc2ec13cfbe0f20a868108a0bd800c0a875c1796) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: drop support for Fedora 30-32Michael Opdenacker2021-12-131-6/+0
| | | | | | | | | | These versions have reached their end of life and we don't test them any more. (From yocto-docs rev: e4ff50fadbf61bf29015e9eded2584731c5d2bb2) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: drop support for Ubuntu 16.04Michael Opdenacker2021-12-131-2/+0
| | | | | | | | | | There are no more free updates to Ubuntu 16.04 We can no longer test the latest updates to this distro. (From yocto-docs rev: 752636d8924f0aaae1e8df61affef3310ae91aa0) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-system-requirements.rst: Add openSUSE Leap 15.2 to list of supported distrosSteve Sakoman2021-11-211-0/+2
| | | | | | | (From yocto-docs rev: 895ce3b9dda96a049c92754cf06eb34635097861) Signed-off-by: Steve Sakoman <steve@sakoman.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-system-requirements.rst: Add Fedora 33 and 34 to list of supported distrosSteve Sakoman2021-11-211-0/+4
| | | | | | | | (From yocto-docs rev: b85b532b8360756798c08482b94758d5df55f5ed) Signed-off-by: Steve Sakoman <steve@sakoman.com> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-system-requirements.rst: Add Debian 11 to list of supported distrosSteve Sakoman2021-11-211-1/+2
| | | | | | | | (From yocto-docs rev: aa212ce6c6fb9b92e0cf4e32ae8d2458aab4a055) Signed-off-by: Steve Sakoman <steve@sakoman.com> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: replace "apt-get" by "apt"Michael Opdenacker2021-10-081-5/+5
| | | | | | | | | | | | | Modern Debian based distros (such as Ubuntu) now use "apt" instead of "apt-get" Also make sure "apt" is invoked with root privileges (mandatory) (From yocto-docs rev: 380ef2474f3ecc2bce83f11cd838d054bef56d22) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: couple minor tweaks to Chapter 1Robert P. J. Day2021-09-181-2/+3
| | | | | | | | | (From yocto-docs rev: d00282396ddc558bf025a81edc1dad53a814e13a) 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>
* ref-manual: simplify styleMichael Opdenacker2021-05-221-5/+3
| | | | | | | (From yocto-docs rev: 657a7f54856afd6fec7f2cb0b5f12b4b2d24adb7) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Ubuntu 20.04 is also LTSRoss Burton2021-05-221-1/+1
| | | | | | | | (From yocto-docs rev: e7b7ec18c27b34e96de9b576b8bfe518f7466bff) 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>
* manuals: reduce verbosity related to "the following" expressionMichael Opdenacker2021-05-131-5/+5
| | | | | | | (From yocto-docs rev: da9d1cfb5c084d172eff3cb10ec3631dd8266260) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: code insertion simplification over two linesMichael Opdenacker2021-04-231-46/+23
| | | | | | | | | | | | | | | 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>
* ref-manual: tweak buildtools sectionPaul Eggleton2021-04-151-2/+6
| | | | | | | | | | 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>
* ref-manual: fix reference to build-essentialPaul Eggleton2021-04-151-1/+2
| | | | | | | | | 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>
* Use variables for minimum host versions and bump Python to 3.6Paul Eggleton2021-04-151-4/+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>
* manuals: Fix typos and spacingMichael Opdenacker2021-04-061-1/+1
| | | | | | | | | | 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>
* manuals: Spellcheck and capitalization fixesMichael Opdenacker2021-04-061-1/+1
| | | | | | | | | | | | | | | - 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>
* docs: fix missing & and ; surrounding references from poky.yamlQuentin Schulz2021-01-201-2/+2
| | | | | | | | | | | | 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>
* ref-manual: remove 'ref' from filenamesNicolas Dechesne2020-12-091-0/+442
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>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2026-02-26 12:10:05 +0000