diff options
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/bsp-guide/bsp.rst | 6 | ||||
| -rw-r--r-- | documentation/conf.py | 22 | ||||
| -rw-r--r-- | documentation/overview-manual/yp-intro.rst | 2 | ||||
| -rw-r--r-- | documentation/poky.yaml | 10 | ||||
| -rw-r--r-- | documentation/ref-manual/system-requirements.rst | 2 | ||||
| -rw-r--r-- | documentation/releases.rst | 7 |
6 files changed, 38 insertions, 11 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. #. *Determine the BSP Layer You Want:* The Yocto Project supports many BSPs, which are maintained in their own layers or in layers designed to contain several BSPs. To get an idea of machine support through - BSP layers, you can look at the `index of - machines <&YOCTO_RELEASE_DL_URL;/machines>`__ for the release. + BSP layers, you can look at the :yocto_dl:`index of machines + </releases/yocto/&DISTRO_REL_TAG;/machines>` #. *Optionally Clone the meta-intel BSP Layer:* If your hardware is based on current Intel CPUs and devices, you can leverage this BSP @@ -879,7 +879,7 @@ Yocto Project: your BSP layer as listed in the ``recipes.txt`` file, which is found in ``poky/meta`` directory of the :term:`Source Directory` or in the OpenEmbedded-Core Layer (``openembedded-core``) at - https://git.openembedded.org/openembedded-core/tree/meta. + :oe_git:`/openembedded-core/tree/meta`. You should place recipes (``*.bb`` files) and recipe modifications (``*.bbappend`` files) into ``recipes-*`` subdirectories by diff --git a/documentation/conf.py b/documentation/conf.py index e42e7b18a7..d2478ae00b 100644 --- a/documentation/conf.py +++ b/documentation/conf.py @@ -15,9 +15,27 @@ import os import sys import datetime +try: + import yaml +except ImportError: + sys.stderr.write("The Yocto Project Sphinx documentation requires PyYAML.\ + \nPlease make sure to install pyyaml python package.\n") + sys.exit(1) -current_version = "3.3.4" -bitbake_version = "1.50" +# current_version = "dev" +# bitbake_version = "" # Leave empty for development branch +# Obtain versions from poky.yaml instead +with open("poky.yaml") as data: + buff = data.read() + subst_vars = yaml.safe_load(buff) + if "DOCCONF_VERSION" not in subst_vars: + sys.stderr.write("Please set DOCCONF_VERSION in poky.yaml") + sys.exit(1) + current_version = subst_vars["DOCCONF_VERSION"] + if "BITBAKE_SERIES" not in subst_vars: + sys.stderr.write("Please set BITBAKE_SERIES in poky.yaml") + sys.exit(1) + bitbake_version = subst_vars["BITBAKE_SERIES"] # String used in sidebar version = 'Version: ' + current_version 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. possible. - Familiarize yourself with the `Yocto Project curated layer - index <https://www.yoctoproject.org/software-overview/layers/>`__ + index :yocto_home:`/software-overview/layers/` or the :oe_layerindex:`OpenEmbedded layer index <>`. The latter contains more layers but they are less universally 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 @@ -DISTRO : "3.3.4" +DISTRO : "3.3.6" DISTRO_NAME_NO_CAP : "hardknott" DISTRO_NAME : "Hardknott" DISTRO_NAME_NO_CAP_MINUS_ONE : "gatesgarth" DISTRO_NAME_NO_CAP_LTS : "gatesgarth" -YOCTO_DOC_VERSION : "3.3.4" +YOCTO_DOC_VERSION : "3.3.6" YOCTO_DOC_VERSION_MINUS_ONE : "3.2.4" -DISTRO_REL_TAG : "yocto-3.3.4" -POKYVERSION : "25.0.4" +DISTRO_REL_TAG : "yocto-3.3.6" +DOCCONF_VERSION : "3.3.6" +BITBAKE_SERIES : "1.50" +POKYVERSION : "25.0.6" YOCTO_POKY : "poky-&DISTRO_NAME_NO_CAP;-&POKYVERSION;" YOCTO_DL_URL : "https://downloads.yoctoproject.org" YOCTO_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 download and run a pre-built buildtools installer yourself with the following steps: -1. Locate and download the ``*.sh`` at &YOCTO_RELEASE_DL_URL;/buildtools/ +1. Locate and download the ``*.sh`` at :yocto_dl:`/releases/yocto/&DISTRO_REL_TAG;/buildtools/` 2. Execute the installation script. Here is an example for the traditional installer: diff --git a/documentation/releases.rst b/documentation/releases.rst index acee21d6ba..233448c68a 100644 --- a/documentation/releases.rst +++ b/documentation/releases.rst @@ -10,6 +10,8 @@ - :yocto_docs:`3.4 Documentation </3.4>` - :yocto_docs:`3.4.1 Documentation </3.4.1>` +- :yocto_docs:`3.4.2 Documentation </3.4.2>` +- :yocto_docs:`3.4.3 Documentation </3.4.3>` ******************************* 3.3 'hardknott' Release Series @@ -20,6 +22,8 @@ - :yocto_docs:`3.3.2 Documentation </3.3.2>` - :yocto_docs:`3.3.3 Documentation </3.3.3>` - :yocto_docs:`3.3.4 Documentation </3.3.4>` +- :yocto_docs:`3.3.5 Documentation </3.3.5>` +- :yocto_docs:`3.3.6 Documentation </3.3.6>` **************************** 3.1 'dunfell' Release Series @@ -38,6 +42,9 @@ - :yocto_docs:`3.1.10 Documentation </3.1.10>` - :yocto_docs:`3.1.11 Documentation </3.1.11>` - :yocto_docs:`3.1.12 Documentation </3.1.12>` +- :yocto_docs:`3.1.13 Documentation </3.1.13>` +- :yocto_docs:`3.1.14 Documentation </3.1.14>` +- :yocto_docs:`3.1.15 Documentation </3.1.15>` ========================== Previous Release Manuals |