diff options
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/bsp-guide/bsp.rst | 6 | ||||
| -rw-r--r-- | documentation/conf.py | 23 | ||||
| -rw-r--r-- | documentation/overview-manual/yp-intro.rst | 2 | ||||
| -rw-r--r-- | documentation/poky.yaml | 13 | ||||
| -rw-r--r-- | documentation/ref-manual/migration-3.0.rst | 5 | ||||
| -rw-r--r-- | documentation/ref-manual/system-requirements.rst | 2 | ||||
| -rw-r--r-- | documentation/ref-manual/tasks.rst | 19 | ||||
| -rw-r--r-- | documentation/releases.rst | 38 | ||||
| -rw-r--r-- | documentation/sphinx-static/switchers.js | 8 |
9 files changed, 76 insertions, 40 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 d1c08a9c98..d2478ae00b 100644 --- a/documentation/conf.py +++ b/documentation/conf.py @@ -15,8 +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.3" +# 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 @@ -89,7 +108,7 @@ extlinks = { # Intersphinx config to use cross reference with Bitbake user manual intersphinx_mapping = { - 'bitbake': ('https://docs.yoctoproject.org/bitbake/', None) + 'bitbake': ('https://docs.yoctoproject.org/bitbake/' + bitbake_version, None) } # -- 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. 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 02c9bf3dcb..d57b4d7101 100644 --- a/documentation/poky.yaml +++ b/documentation/poky.yaml @@ -1,12 +1,14 @@ -DISTRO : "3.3.3" +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.3" +YOCTO_DOC_VERSION : "3.3.6" YOCTO_DOC_VERSION_MINUS_ONE : "3.2.4" -DISTRO_REL_TAG : "yocto-3.3.3" -POKYVERSION : "25.0.3" +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" @@ -19,7 +21,8 @@ FEDORA_HOST_PACKAGES_ESSENTIAL : "gawk make wget tar bzip2 gzip python3 unzip pe diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath \ ccache perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue perl-bignum socat \ python3-pexpect findutils which file cpio python python3-pip xz python3-GitPython \ - python3-jinja2 SDL-devel xterm rpcgen mesa-libGL-devel" + python3-jinja2 SDL-devel xterm rpcgen mesa-libGL-devel perl-FindBin perl-File-Compare \ + perl-File-Copy perl-locale" OPENSUSE_HOST_PACKAGES_ESSENTIAL : "python gcc gcc-c++ git chrpath make wget python-xml \ diffstat makeinfo python-curses patch socat python3 python3-curses tar python3-pip \ python3-pexpect xz which python3-Jinja2 Mesa-libEGL1 libSDL-devel xterm rpcgen Mesa-dri-devel diff --git a/documentation/ref-manual/migration-3.0.rst b/documentation/ref-manual/migration-3.0.rst index f3d20e2eda..2a475fc6f4 100644 --- a/documentation/ref-manual/migration-3.0.rst +++ b/documentation/ref-manual/migration-3.0.rst @@ -184,9 +184,8 @@ The following BitBake changes have occurred. exceptions. Remove this argument in any calls to ``bb.build.exec_func()`` in custom classes or scripts. -- The - :term:`bitbake:BB_SETSCENE_VERIFY_FUNCTION2` - is no longer used. In the unlikely event that you have any references +- The ``BB_SETSCENE_VERIFY_FUNCTION2`` variable is no longer used. + In the unlikely event that you have any references to it, they should be removed. - The ``RunQueueExecuteScenequeue`` and ``RunQueueExecuteTasks`` events 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/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: file://file;apply=yes \ " -Conversely, if you have a directory full of patch files and you want to -exclude some so that the ``do_patch`` task does not apply them during -the patch phase, you can use the "apply=no" parameter with the -``SRC_URI`` statement: -:: +Conversely, if you have a file whose file type is ``.patch`` or ``.diff`` +and you want to exclude it so that the ``do_patch`` task does not apply +it during the patch phase, you can use the "apply=no" parameter with the +:term:`SRC_URI` statement:: SRC_URI = " \ git://path_to_repo/some_package \ - file://path_to_lots_of_patch_files \ - file://path_to_lots_of_patch_files/patch_file5;apply=no \ + file://file1.patch \ + file://file2.patch;apply=no \ " -In the -previous example, assuming all the files in the directory holding the -patch files end with either ``.patch`` or ``.diff``, every file would be -applied as a patch by default except for the ``patch_file5`` patch. +In the previous example ``file1.patch`` would be applied as a patch by default +while ``file2.patch`` would not be applied. You can find out more about the patching process in the ":ref:`overview-manual/concepts:patching`" section in diff --git a/documentation/releases.rst b/documentation/releases.rst index 2b17cd6359..233448c68a 100644 --- a/documentation/releases.rst +++ b/documentation/releases.rst @@ -5,6 +5,15 @@ ========================= ******************************* +3.4 'honister' Release Series +******************************* + +- :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 ******************************* @@ -12,17 +21,9 @@ - :yocto_docs:`3.3.1 Documentation </3.3.1>` - :yocto_docs:`3.3.2 Documentation </3.3.2>` - :yocto_docs:`3.3.3 Documentation </3.3.3>` - - -******************************* -3.2 'gatesgarth' Release Series -******************************* - -- :yocto_docs:`3.2 Documentation </3.2>` -- :yocto_docs:`3.2.1 Documentation </3.2.1>` -- :yocto_docs:`3.2.2 Documentation </3.2.2>` -- :yocto_docs:`3.2.3 Documentation </3.2.3>` -- :yocto_docs:`3.2.4 Documentation </3.2.4>` +- :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 @@ -39,11 +40,26 @@ - :yocto_docs:`3.1.8 Documentation </3.1.8>` - :yocto_docs:`3.1.9 Documentation </3.1.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 ========================== +******************************* +3.2 'gatesgarth' Release Series +******************************* + +- :yocto_docs:`3.2 Documentation </3.2>` +- :yocto_docs:`3.2.1 Documentation </3.2.1>` +- :yocto_docs:`3.2.2 Documentation </3.2.2>` +- :yocto_docs:`3.2.3 Documentation </3.2.3>` +- :yocto_docs:`3.2.4 Documentation </3.2.4>` + ************************* 3.0 'zeus' Release Series ************************* 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 @@ 'use strict'; var all_versions = { - 'dev': 'dev (3.3)', - '3.2.3': '3.2.3', - '3.1.6': '3.1.6', + 'dev': 'dev (3.5)', + '3.4.1': '3.4.1', + '3.3.4': '3.3.4', + '3.2.4': '3.2.4', + '3.1.12': '3.1.12', '3.0.4': '3.0.4', '2.7.4': '2.7.4', }; |