Commit Graph

42 Commits

Author SHA1 Message Date
Michael Opdenacker
0c8b5d0e69 contributor guide: call section "Reporting a defect"
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>
2023-08-30 15:54:59 +01:00
Michael Opdenacker
34864ad94c ref-manual: update supported distro versions
- 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>
2023-08-30 15:54:59 +01:00
Michael Opdenacker
8a11abf6a9 manuals: create a dedicated "Contributor Guide" document
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>
2023-08-30 15:54:59 +01:00
Michael Opdenacker
85bfe72efe migration-guides: release-notes-4.2: add doc improvement highlights
(From yocto-docs rev: 66b5f10bf0747b6ae0a8fbb05103e2f1070b6474)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-05-26 17:32:50 +01:00
Michael Opdenacker
3ce82d9737 ref-manual: system-requirements.rst: fix AlmaLinux variable name
(From yocto-docs rev: d84b771e2ca22fa7dd9525dc515d3972035366eb)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-05-03 10:00:32 +01:00
Michael Opdenacker
311c76c8e8 manuals: improve and fix target for supported distros
- 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>
2023-04-06 14:35:18 +01:00
Michael Opdenacker
88b440af71 manuals: add minimum RAM requirements
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>
2023-04-03 14:48:47 +01:00
Michael Opdenacker
c8b7c5ab1e manuals: update disk space requirements
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>
2023-04-03 14:48:47 +01:00
Michael Opdenacker
ee1a0825b7 ref-manual: system-requirements.rst: simplify supported distro requirements
- 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>
2023-03-20 13:16:52 +00:00
Michael Opdenacker
443a9f2658 poky.yaml.in, system-requirements.rst: update system requirements
- 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>
2023-03-20 13:16:52 +00:00
Michael Opdenacker
6175e5bc9d ref-manual: system-requirements.rst: update supported distros
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>
2023-02-24 15:43:25 +00:00
Michael Opdenacker
69abe10566 ref-manual/system-requirements.rst: recommend buildtools for not supported 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>
2023-01-06 17:39:09 +00:00
Michael Opdenacker
eb5042210c manuals: create references to buildtools
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>
2022-12-18 10:41:21 +00:00
Michael Opdenacker
4925cd4168 ref-manual/system-requirements.rst: update buildtools instructions
- 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>
2022-12-18 10:41:21 +00:00
Michael Opdenacker
6846d4d00b manuals: define proper numbered lists
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>
2022-12-18 10:41:21 +00:00
Michael Opdenacker
945c669138 manuals: split dev-manual/common-tasks.rst
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>
2022-12-01 19:20:29 +00:00
Paul Eggleton
20cf9c46a1 ref-manual: add info on buildtools-make-tarball
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>
2022-10-28 15:48:03 +01:00
Michael Opdenacker
3a3a9728ec manuals: updates for building on Windows (WSL 2)
- 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>
2022-10-25 13:41:36 +01:00
Michael Opdenacker
f2803414b9 ref-manual: system-requirements: Ubuntu 22.04 now supported
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>
2022-10-07 10:54:26 +01:00
Armin Kuster
f7763317f8 system-requirements.rst: remove EOL and Centos7 hosts
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>
2022-08-12 23:11:28 +01:00
Quentin Schulz
3eb3888ef0 docs: ref-manual: system-requirements: add missing packages
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>
2022-08-12 23:11:28 +01:00
Michael Opdenacker
f7f4444e36 manuals: update host tool requirements
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>
2022-06-21 20:57:17 +01:00
Michael Opdenacker
81664f1adc docs: ref-system-requirements.rst: update list of supported distros
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>
2022-03-16 14:25:02 +00:00
Quentin Schulz
89544cf511 docs: fix hardcoded link warning messages
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>
2022-02-23 18:12:10 +00:00
Michael Opdenacker
6a353d9322 ref-manual: drop support for Fedora 30-32
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>
2021-12-13 23:31:34 +00:00
Michael Opdenacker
6df1694cd4 ref-manual: drop support for Ubuntu 16.04
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>
2021-12-13 23:31:34 +00:00
Steve Sakoman
35cdb70406 ref-system-requirements.rst: Add openSUSE Leap 15.2 to list of supported distros
(From yocto-docs rev: 895ce3b9dda96a049c92754cf06eb34635097861)

Signed-off-by: Steve Sakoman <steve@sakoman.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-21 11:07:01 +00:00
Steve Sakoman
f4de0f7fcd ref-system-requirements.rst: Add Fedora 33 and 34 to list of supported distros
(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>
2021-11-21 11:07:01 +00:00
Steve Sakoman
941a08f379 ref-system-requirements.rst: Add Debian 11 to list of supported distros
(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>
2021-11-21 11:07:01 +00:00
Michael Opdenacker
33ea53f00d manuals: replace "apt-get" by "apt"
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>
2021-10-08 22:01:24 +01:00
Robert P. J. Day
70059b37c7 ref-manual: couple minor tweaks to Chapter 1
(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>
2021-09-18 13:03:45 +01:00
Michael Opdenacker
4db4e4ca46 ref-manual: simplify style
(From yocto-docs rev: 657a7f54856afd6fec7f2cb0b5f12b4b2d24adb7)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-05-22 12:16:40 +01:00
Ross Burton
c17083af21 ref-manual: Ubuntu 20.04 is also LTS
(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>
2021-05-22 12:16:40 +01:00
Michael Opdenacker
d4a82b30b7 manuals: reduce verbosity related to "the following" expression
(From yocto-docs rev: da9d1cfb5c084d172eff3cb10ec3631dd8266260)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-05-13 11:28:34 +01:00
Michael Opdenacker
c3c6de2187 manuals: code insertion simplification over two lines
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>
2021-04-23 16:39:03 +01:00
Paul Eggleton
5b11fd8881 ref-manual: tweak buildtools section
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-15 20:18:58 +01:00
Paul Eggleton
93e2dd396e ref-manual: fix reference to build-essential
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-15 20:18:58 +01:00
Paul Eggleton
8396001238 Use variables for minimum host versions and bump Python to 3.6
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-15 20:18:57 +01:00
Michael Opdenacker
44d0532c89 manuals: Fix typos and spacing
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-06 22:29:49 +01:00
Michael Opdenacker
c643a4749c manuals: Spellcheck and capitalization fixes
- 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-06 22:29:49 +01:00
Quentin Schulz
e6a0be545d docs: fix missing & and ; surrounding references from poky.yaml
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-20 00:53:53 +00:00
Nicolas Dechesne
b70318797c ref-manual: remove 'ref' from filenames
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>
2020-12-09 12:21:27 +00:00