summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/bsp-guide/bsp.rst6
-rw-r--r--documentation/conf.py23
-rw-r--r--documentation/overview-manual/yp-intro.rst2
-rw-r--r--documentation/poky.yaml10
-rw-r--r--documentation/ref-manual/system-requirements.rst2
-rw-r--r--documentation/ref-manual/tasks.rst19
-rw-r--r--documentation/releases.rst36
-rw-r--r--documentation/sphinx-static/switchers.js8
8 files changed, 70 insertions, 36 deletions
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst
index 89f1564422..daa7ba4bb2 100644
--- a/documentation/bsp-guide/bsp.rst
+++ b/documentation/bsp-guide/bsp.rst
@@ -166,8 +166,8 @@ section.
166#. *Determine the BSP Layer You Want:* The Yocto Project supports many 166#. *Determine the BSP Layer You Want:* The Yocto Project supports many
167 BSPs, which are maintained in their own layers or in layers designed 167 BSPs, which are maintained in their own layers or in layers designed
168 to contain several BSPs. To get an idea of machine support through 168 to contain several BSPs. To get an idea of machine support through
169 BSP layers, you can look at the `index of 169 BSP layers, you can look at the :yocto_dl:`index of machines
170 machines <&YOCTO_RELEASE_DL_URL;/machines>`__ for the release. 170 </releases/yocto/&DISTRO_REL_TAG;/machines>`
171 171
172#. *Optionally Clone the meta-intel BSP Layer:* If your hardware is 172#. *Optionally Clone the meta-intel BSP Layer:* If your hardware is
173 based on current Intel CPUs and devices, you can leverage this BSP 173 based on current Intel CPUs and devices, you can leverage this BSP
@@ -879,7 +879,7 @@ Yocto Project:
879 your BSP layer as listed in the ``recipes.txt`` file, which is found 879 your BSP layer as listed in the ``recipes.txt`` file, which is found
880 in ``poky/meta`` directory of the :term:`Source Directory` 880 in ``poky/meta`` directory of the :term:`Source Directory`
881 or in the OpenEmbedded-Core Layer (``openembedded-core``) at 881 or in the OpenEmbedded-Core Layer (``openembedded-core``) at
882 https://git.openembedded.org/openembedded-core/tree/meta. 882 :oe_git:`/openembedded-core/tree/meta`.
883 883
884 You should place recipes (``*.bb`` files) and recipe modifications 884 You should place recipes (``*.bb`` files) and recipe modifications
885 (``*.bbappend`` files) into ``recipes-*`` subdirectories by 885 (``*.bbappend`` files) into ``recipes-*`` subdirectories by
diff --git a/documentation/conf.py b/documentation/conf.py
index 28af37d7b1..d2478ae00b 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -15,8 +15,27 @@
15import os 15import os
16import sys 16import sys
17import datetime 17import datetime
18try:
19 import yaml
20except ImportError:
21 sys.stderr.write("The Yocto Project Sphinx documentation requires PyYAML.\
22 \nPlease make sure to install pyyaml python package.\n")
23 sys.exit(1)
18 24
19current_version = "3.3.4" 25# current_version = "dev"
26# bitbake_version = "" # Leave empty for development branch
27# Obtain versions from poky.yaml instead
28with open("poky.yaml") as data:
29 buff = data.read()
30 subst_vars = yaml.safe_load(buff)
31 if "DOCCONF_VERSION" not in subst_vars:
32 sys.stderr.write("Please set DOCCONF_VERSION in poky.yaml")
33 sys.exit(1)
34 current_version = subst_vars["DOCCONF_VERSION"]
35 if "BITBAKE_SERIES" not in subst_vars:
36 sys.stderr.write("Please set BITBAKE_SERIES in poky.yaml")
37 sys.exit(1)
38 bitbake_version = subst_vars["BITBAKE_SERIES"]
20 39
21# String used in sidebar 40# String used in sidebar
22version = 'Version: ' + current_version 41version = 'Version: ' + current_version
@@ -89,7 +108,7 @@ extlinks = {
89 108
90# Intersphinx config to use cross reference with Bitbake user manual 109# Intersphinx config to use cross reference with Bitbake user manual
91intersphinx_mapping = { 110intersphinx_mapping = {
92 'bitbake': ('https://docs.yoctoproject.org/bitbake/', None) 111 'bitbake': ('https://docs.yoctoproject.org/bitbake/' + bitbake_version, None)
93} 112}
94 113
95# -- Options for HTML output ------------------------------------------------- 114# -- Options for HTML output -------------------------------------------------
diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst
index fca02e4cec..8e0c6a8cb1 100644
--- a/documentation/overview-manual/yp-intro.rst
+++ b/documentation/overview-manual/yp-intro.rst
@@ -221,7 +221,7 @@ your Metadata, the easier it is to cope with future changes.
221 possible. 221 possible.
222 222
223 - Familiarize yourself with the `Yocto Project curated layer 223 - Familiarize yourself with the `Yocto Project curated layer
224 index <https://www.yoctoproject.org/software-overview/layers/>`__ 224 index :yocto_home:`/software-overview/layers/`
225 or the :oe_layerindex:`OpenEmbedded layer index <>`. 225 or the :oe_layerindex:`OpenEmbedded layer index <>`.
226 The latter contains more layers but they are less universally 226 The latter contains more layers but they are less universally
227 validated. 227 validated.
diff --git a/documentation/poky.yaml b/documentation/poky.yaml
index 30eb453796..d57b4d7101 100644
--- a/documentation/poky.yaml
+++ b/documentation/poky.yaml
@@ -1,12 +1,14 @@
1DISTRO : "3.3.4" 1DISTRO : "3.3.6"
2DISTRO_NAME_NO_CAP : "hardknott" 2DISTRO_NAME_NO_CAP : "hardknott"
3DISTRO_NAME : "Hardknott" 3DISTRO_NAME : "Hardknott"
4DISTRO_NAME_NO_CAP_MINUS_ONE : "gatesgarth" 4DISTRO_NAME_NO_CAP_MINUS_ONE : "gatesgarth"
5DISTRO_NAME_NO_CAP_LTS : "gatesgarth" 5DISTRO_NAME_NO_CAP_LTS : "gatesgarth"
6YOCTO_DOC_VERSION : "3.3.4" 6YOCTO_DOC_VERSION : "3.3.6"
7YOCTO_DOC_VERSION_MINUS_ONE : "3.2.4" 7YOCTO_DOC_VERSION_MINUS_ONE : "3.2.4"
8DISTRO_REL_TAG : "yocto-3.3.4" 8DISTRO_REL_TAG : "yocto-3.3.6"
9POKYVERSION : "25.0.4" 9DOCCONF_VERSION : "3.3.6"
10BITBAKE_SERIES : "1.50"
11POKYVERSION : "25.0.6"
10YOCTO_POKY : "poky-&DISTRO_NAME_NO_CAP;-&POKYVERSION;" 12YOCTO_POKY : "poky-&DISTRO_NAME_NO_CAP;-&POKYVERSION;"
11YOCTO_DL_URL : "https://downloads.yoctoproject.org" 13YOCTO_DL_URL : "https://downloads.yoctoproject.org"
12YOCTO_AB_URL : "https://autobuilder.yoctoproject.org" 14YOCTO_AB_URL : "https://autobuilder.yoctoproject.org"
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst
index 80378cedb7..38a3974a30 100644
--- a/documentation/ref-manual/system-requirements.rst
+++ b/documentation/ref-manual/system-requirements.rst
@@ -339,7 +339,7 @@ If you would prefer not to use the ``install-buildtools`` script, you can instea
339download and run a pre-built buildtools installer yourself with the following 339download and run a pre-built buildtools installer yourself with the following
340steps: 340steps:
341 341
3421. Locate and download the ``*.sh`` at &YOCTO_RELEASE_DL_URL;/buildtools/ 3421. Locate and download the ``*.sh`` at :yocto_dl:`/releases/yocto/&DISTRO_REL_TAG;/buildtools/`
343 343
3442. Execute the installation script. Here is an example for the 3442. Execute the installation script. Here is an example for the
345 traditional installer: 345 traditional installer:
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst
index 9fe1c296aa..ca19908bc9 100644
--- a/documentation/ref-manual/tasks.rst
+++ b/documentation/ref-manual/tasks.rst
@@ -331,22 +331,19 @@ file as a patch file:
331 file://file;apply=yes \ 331 file://file;apply=yes \
332 " 332 "
333 333
334Conversely, if you have a directory full of patch files and you want to 334Conversely, if you have a file whose file type is ``.patch`` or ``.diff``
335exclude some so that the ``do_patch`` task does not apply them during 335and you want to exclude it so that the ``do_patch`` task does not apply
336the patch phase, you can use the "apply=no" parameter with the 336it during the patch phase, you can use the "apply=no" parameter with the
337``SRC_URI`` statement: 337:term:`SRC_URI` statement::
338::
339 338
340 SRC_URI = " \ 339 SRC_URI = " \
341 git://path_to_repo/some_package \ 340 git://path_to_repo/some_package \
342 file://path_to_lots_of_patch_files \ 341 file://file1.patch \
343 file://path_to_lots_of_patch_files/patch_file5;apply=no \ 342 file://file2.patch;apply=no \
344 " 343 "
345 344
346In the 345In the previous example ``file1.patch`` would be applied as a patch by default
347previous example, assuming all the files in the directory holding the 346while ``file2.patch`` would not be applied.
348patch files end with either ``.patch`` or ``.diff``, every file would be
349applied as a patch by default except for the ``patch_file5`` patch.
350 347
351You can find out more about the patching process in the 348You can find out more about the patching process in the
352":ref:`overview-manual/concepts:patching`" section in 349":ref:`overview-manual/concepts:patching`" section in
diff --git a/documentation/releases.rst b/documentation/releases.rst
index e19dfde6c8..233448c68a 100644
--- a/documentation/releases.rst
+++ b/documentation/releases.rst
@@ -5,6 +5,15 @@
5========================= 5=========================
6 6
7******************************* 7*******************************
83.4 'honister' Release Series
9*******************************
10
11- :yocto_docs:`3.4 Documentation </3.4>`
12- :yocto_docs:`3.4.1 Documentation </3.4.1>`
13- :yocto_docs:`3.4.2 Documentation </3.4.2>`
14- :yocto_docs:`3.4.3 Documentation </3.4.3>`
15
16*******************************
83.3 'hardknott' Release Series 173.3 'hardknott' Release Series
9******************************* 18*******************************
10 19
@@ -13,17 +22,8 @@
13- :yocto_docs:`3.3.2 Documentation </3.3.2>` 22- :yocto_docs:`3.3.2 Documentation </3.3.2>`
14- :yocto_docs:`3.3.3 Documentation </3.3.3>` 23- :yocto_docs:`3.3.3 Documentation </3.3.3>`
15- :yocto_docs:`3.3.4 Documentation </3.3.4>` 24- :yocto_docs:`3.3.4 Documentation </3.3.4>`
16 25- :yocto_docs:`3.3.5 Documentation </3.3.5>`
17 26- :yocto_docs:`3.3.6 Documentation </3.3.6>`
18*******************************
193.2 'gatesgarth' Release Series
20*******************************
21
22- :yocto_docs:`3.2 Documentation </3.2>`
23- :yocto_docs:`3.2.1 Documentation </3.2.1>`
24- :yocto_docs:`3.2.2 Documentation </3.2.2>`
25- :yocto_docs:`3.2.3 Documentation </3.2.3>`
26- :yocto_docs:`3.2.4 Documentation </3.2.4>`
27 27
28**************************** 28****************************
293.1 'dunfell' Release Series 293.1 'dunfell' Release Series
@@ -41,11 +41,25 @@
41- :yocto_docs:`3.1.9 Documentation </3.1.9>` 41- :yocto_docs:`3.1.9 Documentation </3.1.9>`
42- :yocto_docs:`3.1.10 Documentation </3.1.10>` 42- :yocto_docs:`3.1.10 Documentation </3.1.10>`
43- :yocto_docs:`3.1.11 Documentation </3.1.11>` 43- :yocto_docs:`3.1.11 Documentation </3.1.11>`
44- :yocto_docs:`3.1.12 Documentation </3.1.12>`
45- :yocto_docs:`3.1.13 Documentation </3.1.13>`
46- :yocto_docs:`3.1.14 Documentation </3.1.14>`
47- :yocto_docs:`3.1.15 Documentation </3.1.15>`
44 48
45========================== 49==========================
46 Previous Release Manuals 50 Previous Release Manuals
47========================== 51==========================
48 52
53*******************************
543.2 'gatesgarth' Release Series
55*******************************
56
57- :yocto_docs:`3.2 Documentation </3.2>`
58- :yocto_docs:`3.2.1 Documentation </3.2.1>`
59- :yocto_docs:`3.2.2 Documentation </3.2.2>`
60- :yocto_docs:`3.2.3 Documentation </3.2.3>`
61- :yocto_docs:`3.2.4 Documentation </3.2.4>`
62
49************************* 63*************************
503.0 'zeus' Release Series 643.0 'zeus' Release Series
51************************* 65*************************
diff --git a/documentation/sphinx-static/switchers.js b/documentation/sphinx-static/switchers.js
index 7a4edc9e77..056a8926ba 100644
--- a/documentation/sphinx-static/switchers.js
+++ b/documentation/sphinx-static/switchers.js
@@ -2,9 +2,11 @@
2 'use strict'; 2 'use strict';
3 3
4 var all_versions = { 4 var all_versions = {
5 'dev': 'dev (3.3)', 5 'dev': 'dev (3.5)',
6 '3.2.3': '3.2.3', 6 '3.4.1': '3.4.1',
7 '3.1.6': '3.1.6', 7 '3.3.4': '3.3.4',
8 '3.2.4': '3.2.4',
9 '3.1.12': '3.1.12',
8 '3.0.4': '3.0.4', 10 '3.0.4': '3.0.4',
9 '2.7.4': '2.7.4', 11 '2.7.4': '2.7.4',
10 }; 12 };