Commit Graph

23 Commits

Author SHA1 Message Date
Michael Halstead
f64b796093 releases: update to include 3.3.1
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>
2021-08-04 11:20:48 +01:00
Michael Halstead
c23a25e607 releases: update to include 3.3.1
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>
2021-05-25 22:26:34 +01:00
Armin Kuster
68ee5b4bcc poky.yaml: fedora33: add missing pkgs
[ 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>
2021-05-22 12:16:40 +01:00
Michael Halstead
ed2d99203d releases: update to include 3.2.4
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>
2021-05-18 12:53:08 +01:00
Michael Halstead
6204a3f5f4 releases: update to include 3.3
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>
2021-04-20 14:04:56 +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
Janne Kiiskila
5480a85f01 poky.yaml: Use git instead of git-core for Ubunti
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-06 22:29:49 +01:00
Ross Burton
07c7bdc6c2 poky.yaml: change gcc-multilib to gcc
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-06 15:07:55 +01:00
Richard Purdie
7ca303cdc6 documentation/poky.yaml: Fix latest 3.2 series tag reference
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-06 15:07:55 +01:00
Michael Halstead
e8e10f27b2 releases: update to include 3.2.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>
2021-04-06 09:45:39 +01:00
Michael Halstead
41ee3602ed releases: update to include 3.1.6
(From yocto-docs rev: 05580e574e78039f577d58648b4ee3817c0f09cc)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-02-26 22:36:56 +00:00
Michael Halstead
5f69bf12e5 releases: update to include 3.2.2
(From yocto-docs rev: 1770c9c1e1ce9d28f6d211061010c4a802522c16)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-02-26 15:21:21 +00:00
Michael Halstead
b5e634644b releases: conf: add link to 3.1.5, update to include 3.2.1 & 3.1.5
(From yocto-docs rev: 5c94f8183733bf266cd6153434b5eed22d1914c6)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-01-20 22:50:45 +00:00
Michael Halstead
b3f533aec7 releases: conf: add link to 3.1.4, update to include 3.1.4
(From yocto-docs rev: 20b7be912040ae02fb2df652fb79b09dd5f281e8)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-12-03 12:04:20 +00:00
Paul Barker
adeec77ee2 poky.yaml: Define DISTRO_NAME_NO_CAP_LTS
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>
2020-11-24 09:07:28 +00:00
Nicolas Dechesne
345b5cf155 poky.yaml: updates for 3.2
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>
2020-11-12 13:04:10 +00:00
Nicolas Dechesne
b1d18afd10 poky.yaml: remove unused variables
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>
2020-11-12 13:04:10 +00:00
Robert P. J. Day
43e3a19c19 adt-manual: delete obsolete ADT manual, and related content
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>
2020-10-30 16:03:19 +00:00
Quentin Schulz
9d93373540 docs: poky.yaml: fix identation in host packages variables
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>
2020-10-20 11:12:06 +01:00
Quentin Schulz
c04e9aa806 docs: ref-manual: ref-system-requirements: update requirements to build 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>
2020-10-20 11:12:06 +01:00
Quentin Schulz
7db69417c1 docs: remove OE_INIT_FILE variable
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>
2020-10-20 11:12:06 +01:00
Quentin Schulz
e2a2c80de0 docs: poky.yaml: use HTTPS for links
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>
2020-10-20 11:12:06 +01:00
Nicolas Dechesne
44e8d439aa sphinx: conf: add substitutions/global variables
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>
2020-09-17 10:09:33 +01:00