summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/system-requirements.rst
Commit message (Collapse)AuthorAgeFilesLines
* ref-manual: update tested and supported distrosMichael Opdenacker2024-01-101-11/+12
| | | | | | | | | | | | | | | | | | 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: f169122a4594d7733ebc478d34aaf269801fc068) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* contributor guide: call section "Reporting a defect"Michael Opdenacker2023-08-301-1/+1
| | | | | | | | | | | | | Instead of "Submitting a defect". We all write bugs, and nobody needs documentation support for doing so! (From yocto-docs rev: ce94f6ed029afc8c69e84354c03bd0a9ab14f867) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Joshua Watt <JPEWhacker@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: update supported distro versionsMichael Opdenacker2023-08-301-10/+29
| | | | | | | | | | | | | | | | | | | | - 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 (should be an empty list on master, until the next release is made). (From yocto-docs rev: a2c0918493fb85235d90edd782ec14fa75d10cf1) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: create a dedicated "Contributor Guide" documentMichael Opdenacker2023-08-301-2/+2
| | | | | | | | | | Starting from the original contents of dev-manual/changes.rst and from text contributed by Richard Purdie. (From yocto-docs rev: 55587d9dd009cbc92273376e0f7665b2d574d280) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: release-notes-4.2: add doc improvement highlightsMichael Opdenacker2023-05-261-0/+2
| | | | | | | (From yocto-docs rev: 66b5f10bf0747b6ae0a8fbb05103e2f1070b6474) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: system-requirements.rst: fix AlmaLinux variable nameMichael Opdenacker2023-05-031-1/+1
| | | | | | | (From yocto-docs rev: d84b771e2ca22fa7dd9525dc515d3972035366eb) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: improve and fix target for supported distrosMichael Opdenacker2023-04-061-2/+2
| | | | | | | | | | - Fix the location of the target for supported distributions - Improve the name of this target (From yocto-docs rev: 40f0cf9302b9f0ce01a1270977644b1b2fdfc650) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add minimum RAM requirementsMichael Opdenacker2023-04-031-0/+8
| | | | | | | | | | | | 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: a05f87929eed43cef673a8c2581899a8c9ccf462) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: update disk space requirementsMichael Opdenacker2023-04-031-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: 285ba689ce3ab7b7fdb4bb0d0284e2a52ad62c7f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: system-requirements.rst: simplify supported distro requirementsMichael Opdenacker2023-03-201-49/+34
| | | | | | | | | | | | | | | | | | - 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: 38a3228f8981674bc75de135246c4f9eff7b43a1) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.yaml.in, system-requirements.rst: update system requirementsMichael Opdenacker2023-03-201-5/+5
| | | | | | | | | | | | | | | | | | | | | | | - Update system requirements after making tests on basic Docker containers of: - Ubuntu 22.04 - Fedora 37 - OpenSuse Leap 15.4 - AlmaLinux 9 - Including the need to have the en_US.UTF-8 locale on the system. - Rename the CENTOS8_HOST_PACKAGES_ESSENTIAL macro to ALMALINUX_HOST_PACKAGES_ESSENTIAL As for the other distros, stop refering to a specific version of AlmaLinux. We mention the supported versions in the system-requirements.rst file anyway. - Remove the unused CENTOS7_HOST_PACKAGES_ESSENTIAL macro (From yocto-docs rev: f8b8680ff1f54b02572f240966169b9e129b05b1) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Randy MacLeod <randy.macleod@windriver.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: system-requirements.rst: update supported distrosMichael Opdenacker2023-02-241-4/+6
| | | | | | | | | | Syncing with meta-yocto/meta-poky/conf/distro/poky.conf (From yocto-docs rev: c48256499bafcf57e8b40202fd2d10b28c15daf9) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Steve Sakoman <steve@sakoman.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/system-requirements.rst: recommend buildtools for not supported ↵Michael Opdenacker2023-01-061-3/+8
| | | | | | | | | | | | distros Also minor correction to supported distribution notes (From yocto-docs rev: df8f862042633594846a93a1b7702fc01bc32ae0) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Alexander Kanavin <alex.kanavin@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: create references to buildtoolsMichael Opdenacker2022-12-181-14/+14
| | | | | | | | | On the side, also simplify a reference to the section describing them. (From yocto-docs rev: 0c13a7f9ccee4ddc9c6034d03f47625a09598cec) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/system-requirements.rst: update buildtools instructionsMichael Opdenacker2022-12-181-24/+17
| | | | | | | | | | | | - Stop mentioning the buildtools i586 environment setup file, no longer available. - Remove trivial or redundant instructions. (From yocto-docs rev: 589c7b22b8279ebc62a72106969fde2af92f8753) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: define proper numbered listsMichael Opdenacker2022-12-181-10/+10
| | | | | | | | | | Using "#." instead of "1.", "2.", "3.", etc. (From yocto-docs rev: 11c2585acd0fa6c330702af2359ce5a9e47cde1f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: split dev-manual/common-tasks.rstMichael Opdenacker2022-12-011-1/+1
| | | | | | | | | | | | | | A 500 KB source file is always harder to manage, and can have section title conflicts. So, the "Common Tasks" document is gone and all its constituents are moved up one level. You now have 40 chapters in the Development Tasks Manual. (From yocto-docs rev: 8a45bc469411410020b8e688c137395fcaf3761b) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add info on buildtools-make-tarballPaul Eggleton2022-10-281-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: 3a06c35d059d7d43f7eb33a4f490f5d76afe6cb6) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: updates for building on Windows (WSL 2)Michael Opdenacker2022-10-251-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: 35c5fb01d3543ef5e1f4edf337a2ab080b4e7956) 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: system-requirements: Ubuntu 22.04 now supportedMichael Opdenacker2022-10-071-0/+2
| | | | | | | | | | Following its addition to meta-poky/conf/distro/poky.conf https://git.yoctoproject.org/poky/commit/?id=7786b09212d6ab582db39d0d7d1a4209d36db2ba (From yocto-docs rev: 393e9ae7c37544fd5c2841d99dd9bcd6db03dbbd) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* system-requirements.rst: remove EOL and Centos7 hostsArmin Kuster2022-08-121-48/+3
| | | | | | | | | | | | Commit https://git.yoctoproject.org/poky/commit/?id=d08e47312741a18e7be505d22762b90528253ac9 removed some EOL and CentOS7 from list hos supported hosts. Sync docs with Poky Replace CentOS with AlmaLinux. (From yocto-docs rev: 25a0e14ee8da9f59fa50ec209478e08e6438b827) 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>
* docs: ref-manual: system-requirements: add missing packagesQuentin Schulz2022-08-121-5/+5
| | | | | | | | | | | | | inkscape and the package providing fncychap.sty TeX font were missing from the packages to install to be able to build the documentation, so let's add them to the list. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 4c05a45615ef2b13e9af4b792fb97be116d889b1) 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>
* manuals: update host tool requirementsMichael Opdenacker2022-06-211-2/+4
| | | | | | | | | | | As enforced by meta/classes/sanity.bbclass: - at least GNU make 4.0 - at least GNU tar 7.5 (instead of 5.0) (From yocto-docs rev: 6480aa0f8338ef192c666b9445bc0baff47d9248) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.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 2025-01-15 05:36:50 +0000