Skip to contentSkip to conversation

documentation backports

PATCH New [email protected] 1 participant 8 messages Jan 12, 2024

lore
Share & tools
lore
#0 lore raw

cover documentation backports

From: Michael Opdenacker <[email protected]>

Enguerrand de Ribaucourt (1):
manuals: document VSCode extension

Ilya A. Kriveshko (1):
dev-manual: update license manifest path

Jörg Sommer (1):
documentation: Add UBOOT_BINARY, extend UBOOT_CONFIG

Lee Chee Yang (1):
migration-guide: add release notes for 4.3.2

Maxin B. John (1):
ref-manual: classes: remove insserv bbclass

Michael Opdenacker (1):
contributor-guide: use "apt" instead of "aptitude"

Simone Weiß (1):
dev-manual: start.rst: Update use of Download page

 .../contributor-guide/submit-changes.rst      |   2 +-
 documentation/dev-manual/building.rst         |   4 +
 documentation/dev-manual/licenses.rst         |   2 +-
 documentation/dev-manual/start.rst            |  34 ++-
 .../migration-guides/release-4.3.rst          |   1 +
 .../migration-guides/release-notes-4.3.2.rst  | 247 ++++++++++++++++++
 .../development-environment.rst               |   8 +
 documentation/overview-manual/yp-intro.rst    |  20 ++
 documentation/ref-manual/classes.rst          |  12 +-
 documentation/ref-manual/resources.rst        |   5 +
 documentation/ref-manual/variables.rst        |  39 +--
 documentation/what-i-wish-id-known.rst        |   7 +
 12 files changed, 340 insertions(+), 41 deletions(-)
 create mode 100644 documentation/migration-guides/release-notes-4.3.2.rst
Signature · 1 line
2.34.1
#1 lore raw

PATCH 1/7 dev-manual: start.rst: Update use of Download page

From: Michael Opdenacker <[email protected]>

From: Simone Weiß <[email protected]>

The yocto website has changed its structure. Update the section for Accessing the Downloads page to match the new structure.

---
 documentation/dev-manual/start.rst | 19 ++++++++++---------
 1 file changed, 10 insertions(+), 9 deletions(-)
documentation/dev-manual/start.rst +10 -9
index 4a556967eb..a4f938db3d 100644
@@ -621,7 +621,7 @@ a selection of these components.
 Using the Downloads Page
 ------------------------
 
-The :yocto_home:`Yocto Project Website <>` uses a "DOWNLOADS" page
+The :yocto_home:`Yocto Project Website <>` uses a "RELEASES" page
 from which you can locate and download tarballs of any Yocto Project
 release. Rather than Git repositories, these files represent snapshot
 tarballs similar to the tarballs located in the Index of Releases
@@ -630,12 +630,13 @@ described in the ":ref:`dev-manual/start:accessing source archives`" section.
 #. *Go to the Yocto Project Website:* Open The
    :yocto_home:`Yocto Project Website <>` in your browser.
 
-#. *Get to the Downloads Area:* Select the "DOWNLOADS" item from the
-   pull-down "SOFTWARE" tab menu near the top of the page.
+#. *Get to the Downloads Area:* Select the "RELEASES" item from the
+   pull-down "DEVELOPMENT" tab menu near the top of the page.
 
-#. *Select a Yocto Project Release:* Use the menu next to "RELEASE" to
-   display and choose a recent or past supported Yocto Project release
-   (e.g. &DISTRO_NAME_NO_CAP;, &DISTRO_NAME_NO_CAP_MINUS_ONE;, and so forth).
+#. *Select a Yocto Project Release:* On the top of the "RELEASE" page currently
+   supported releases are displayed, further down past supported Yocto Project
+   releases are visible. The "Download" links in the rows of the table there
+   will lead to the download tarballs for the release.
 
    .. note::
 
@@ -645,9 +646,9 @@ described in the ":ref:`dev-manual/start:accessing source archives`" section.
    You can use the "RELEASE ARCHIVE" link to reveal a menu of all Yocto
    Project releases.
 
-#. *Download Tools or Board Support Packages (BSPs):* From the
-   "DOWNLOADS" page, you can download tools or BSPs as well. Just scroll
-   down the page and look for what you need.
+#. *Download Tools or Board Support Packages (BSPs):* Next to the tarballs you
+   will find download tools or BSPs as well. Just select a Yocto Project
+   release and look for what you need.
 
 Cloning and Checking Out Branches
 =================================
Signature · 1 line
2.34.1
#2 lore raw

PATCH 2/7 contributor-guide: use "apt" instead of "aptitude"

In reply to [email protected]

From: Michael Opdenacker <[email protected]>

As used in the rest of the manual.

---
 documentation/contributor-guide/submit-changes.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
documentation/contributor-guide/submit-changes.rst +1 -1
index 5a6136c8c8..95728c25c6 100644
@@ -57,7 +57,7 @@ Set up Git
 The first thing to do is to install Git packages. Here is an example
 on Debian and Ubuntu::
 
-   sudo aptitude install git-core git-email
+   sudo apt install git-core git-email
 
 Then, you need to set a name and e-mail address that Git will
 use to identify your commits::
Signature · 1 line
2.34.1
#3 lore raw

PATCH 3/7 dev-manual: update license manifest path

In reply to [email protected]

From: Michael Opdenacker <[email protected]>

From: Ilya A. Kriveshko <[email protected]>

After changes in openembedded-core@1a4ab9f, image licenses moved one directory down into ${SSTATE_PKGARCH} subdir.

---
 documentation/dev-manual/licenses.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
documentation/dev-manual/licenses.rst +1 -1
index 3b9190d47f..57713effa0 100644
@@ -332,7 +332,7 @@ completeness.
 
    The Yocto Project generates a license manifest during image creation
    that is located in
-   ``${DEPLOY_DIR}/licenses/<image-name>-<machine>.rootfs-<datestamp>/``
+   ``${DEPLOY_DIR}/licenses/${SSTATE_PKGARCH}/<image-name>-<machine>.rootfs-<datestamp>/``
    to assist with any audits.
 
 Providing the Source Code
Signature · 1 line
2.34.1
#4 lore raw

PATCH 4/7 ref-manual: classes: remove insserv bbclass

In reply to [email protected]

From: Michael Opdenacker <[email protected]>

From: Maxin B. John <[email protected]>

insserv.bbclass was removed from oe-core:

commit e6bb5dbb62257a7de730ea9085dfd89520f3e47d

Author: Richard Purdie <[email protected]>
Date:   Sun May 10 12:30:49 2015 +0100

insserv: Remove

---
 documentation/ref-manual/classes.rst | 10 ----------
 1 file changed, 10 deletions(-)
documentation/ref-manual/classes.rst +0 -10
index a8afe9f2dc..8d8bea4714 100644
@@ -1538,16 +1538,6 @@ Here are the tests you can list with the :term:`WARN_QA` and
    automatically get these versions. Consequently, you should only need
    to explicitly add dependencies to binary driver recipes.
 
-.. _ref-classes-insserv:
-
-``insserv``
-===========
-
-The :ref:`ref-classes-insserv` class uses the ``insserv`` utility to update the order
-of symbolic links in ``/etc/rc?.d/`` within an image based on
-dependencies specified by LSB headers in the ``init.d`` scripts
-themselves.
-
 .. _ref-classes-kernel:
 
 ``kernel``
Signature · 1 line
2.34.1
#5 lore raw

PATCH 5/7 manuals: document VSCode extension

In reply to [email protected]

From: Michael Opdenacker <[email protected]>

From: Enguerrand de Ribaucourt <[email protected]>

The VSCode extension is now officially maintained and published by the Yocto Project so it should be referenced in the manuals to help users discover it.

I located the most relevant places to reference the extension by looking at how the old Eclipse plugin was documented in the 2.6 manuals as well as the current Toaster references.

---
 documentation/dev-manual/building.rst         |  4 ++++
 documentation/dev-manual/start.rst            | 15 +++++++++++---
 .../development-environment.rst               |  8 ++++++++
 documentation/overview-manual/yp-intro.rst    | 20 +++++++++++++++++++
 documentation/ref-manual/resources.rst        |  5 +++++
 documentation/what-i-wish-id-known.rst        |  7 +++++++
 6 files changed, 56 insertions(+), 3 deletions(-)
documentation/dev-manual/building.rst +4 -0
index a395793493..e964bd1aee 100644
@@ -32,6 +32,10 @@ build host running Linux.
       OpenEmbedded build system, see the
       :doc:`/brief-yoctoprojectqs/index` document.
 
+   -  You can also use the `Yocto Project BitBake
+      <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__
+      extension for Visual Studio Code to build images.
+
 The build process creates an entire Linux distribution from source and
 places it in your :term:`Build Directory` under ``tmp/deploy/images``. For
 detailed information on the build process using BitBake, see the
documentation/dev-manual/start.rst +12 -3
index a4f938db3d..b108337795 100644
@@ -334,7 +334,10 @@ to use the Extensible SDK, see the ":doc:`/sdk-manual/extensible`" Chapter in th
 Project Application Development and the Extensible Software Development
 Kit (eSDK) manual. If you want to work on the kernel, see the :doc:`/kernel-dev/index`. If you are going to use
 Toaster, see the ":doc:`/toaster-manual/setup-and-use`"
-section in the Toaster User Manual.
+section in the Toaster User Manual. If you are a VSCode user, you can configure
+the `Yocto Project BitBake
+<https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__
+extension accordingly.
 
 Setting Up to Use CROss PlatformS (CROPS)
 -----------------------------------------
@@ -426,7 +429,10 @@ section. If you are going to use the Extensible SDK container, see the
 Project Application Development and the Extensible Software Development
 Kit (eSDK) manual. If you are going to use the Toaster container, see
 the ":doc:`/toaster-manual/setup-and-use`"
-section in the Toaster User Manual.
+section in the Toaster User Manual. If you are a VSCode user, you can configure
+the `Yocto Project BitBake
+<https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__
+extension accordingly.
 
 Setting Up to Use Windows Subsystem For Linux (WSL 2)
 -----------------------------------------------------
@@ -554,7 +560,10 @@ Extensible SDK container, see the ":doc:`/sdk-manual/extensible`" Chapter in the
 Project Application Development and the Extensible Software Development
 Kit (eSDK) manual. If you are going to use the Toaster container, see
 the ":doc:`/toaster-manual/setup-and-use`"
-section in the Toaster User Manual.
+section in the Toaster User Manual. If you are a VSCode user, you can configure
+the `Yocto Project BitBake
+<https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__
+extension accordingly.
 
 Locating Yocto Project Source Files
 ===================================
documentation/overview-manual/development-environment.rst +8 -0
index 262d5cb203..d79173ff55 100644
@@ -131,6 +131,14 @@ are several ways of working in the Yocto Project environment:
    Toaster and on how to use Toaster in general, see the
    :doc:`/toaster-manual/index`.
 
+-  *Using the VSCode Extension:* You can use the `Yocto Project BitBake
+   <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__
+   extension for Visual Studio Code to start your BitBake builds through a
+   graphical user interface.
+
+   Learn more about the VSCode Extension on the `extension's marketplace page
+   <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__.
+
 Yocto Project Source Repositories
 =================================
 
documentation/overview-manual/yp-intro.rst +20 -0
index d694642af2..1e6820c14e 100644
@@ -340,6 +340,18 @@ the Yocto Project:
    view information about builds. For information on Toaster, see the
    :doc:`/toaster-manual/index`.
 
+-  *VSCode IDE Extension:* The `Yocto Project BitBake
+   <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__
+   extension for Visual Studio Code provides a rich set of features for working
+   with BitBake recipes. The extension provides syntax highlighting,
+   hover tips, and completion for BitBake files as well as embedded Python and
+   Bash languages. Additional views and commands allow you to efficiently
+   browse, build and edit recipes. It also provides SDK integration for
+   cross-compiling and debugging through ``devtool``.
+
+   Learn more about the VSCode Extension on the `extension's frontpage
+   <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__.
+
 Production Tools
 ----------------
 
@@ -605,6 +617,14 @@ Build Host runs, you have several choices.
    For information about and how to use Toaster, see the
    :doc:`/toaster-manual/index`.
 
+-  *Using the VSCode Extension:* You can use the `Yocto Project BitBake
+   <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__
+   extension for Visual Studio Code to start your BitBake builds through a
+   graphical user interface.
+
+   Learn more about the VSCode Extension on the `extension's marketplace page
+   <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__
+
 Reference Embedded Distribution (Poky)
 ======================================
 
documentation/ref-manual/resources.rst +5 -0
index 8c3726e83b..8e54ac87c9 100644
@@ -169,6 +169,11 @@ Here is a list of resources you might find helpful:
    the :term:`OpenEmbedded Build System`, which uses
    BitBake, that reports build information.
 
+-  `Yocto Project BitBake extension for VSCode
+   <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__:
+   This extension provides a rich feature set when working with BitBake recipes
+   within the Visual Studio Code IDE.
+
 -  :yocto_wiki:`FAQ </FAQ>`: A list of commonly asked
    questions and their answers.
 
documentation/what-i-wish-id-known.rst +7 -0
index fe79bc0129..5bc55804f6 100644
@@ -214,6 +214,13 @@ contact us with other suggestions.
      OpenEmbedded build system. If you are interested in using this type of
      interface to create images, see the :doc:`/toaster-manual/index`.
 
+   * **Discover the VSCode extension**: The `Yocto Project BitBake
+     <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__
+     extension for the Visual Studio Code IDE provides language features and
+     commands for working with the Yocto Project. If you are interested in using
+     this extension, visit its `marketplace page
+     <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__.
+
    * **Have Available the Yocto Project Reference Manual**: Unlike the rest of
      the Yocto Project manual set, this manual is comprised of material suited
      for reference rather than procedures. You can get build details, a closer
Signature · 1 line
2.34.1
#6 lore raw

PATCH 6/7 documentation: Add UBOOT_BINARY, extend UBOOT_CONFIG

In reply to [email protected]

From: Michael Opdenacker <[email protected]>

From: Jörg Sommer <[email protected]>

UBOOT_CONFIG accepts a third parameter for the UBOOT_BINARY that isn't documented. To show its usage another example from the meta-freescale layer was picked.

---
 documentation/ref-manual/classes.rst   |  2 +-
 documentation/ref-manual/variables.rst | 39 +++++++++++++++-----------
 2 files changed, 24 insertions(+), 17 deletions(-)
documentation/ref-manual/classes.rst +1 -1
index 8d8bea4714..81dab1f4b3 100644
@@ -3200,7 +3200,7 @@ The :ref:`ref-classes-uboot-config` class provides support for U-Boot configurat
 a machine. Specify the machine in your recipe as follows::
 
    UBOOT_CONFIG ??= <default>
-   UBOOT_CONFIG[foo] = "config,images"
+   UBOOT_CONFIG[foo] = "config,images,binary"
 
 You can also specify the machine using this method::
 
documentation/ref-manual/variables.rst +23 -16
index b394d31099..6f7d6ff01e 100644
@@ -9383,23 +9383,30 @@ system and gives an overview of their function and contents.
       See the machine include files in the :term:`Source Directory`
       for these features.
 
+   :term:`UBOOT_BINARY`
+      Specifies the name of the binary build by U-Boot.
+
    :term:`UBOOT_CONFIG`
-      Configures the :term:`UBOOT_MACHINE` and can
-      also define :term:`IMAGE_FSTYPES` for individual
-      cases.
-
-      Following is an example from the ``meta-fsl-arm`` layer. ::
-
-         UBOOT_CONFIG ??= "sd"
-         UBOOT_CONFIG[sd] = "mx6qsabreauto_config,sdcard"
-         UBOOT_CONFIG[eimnor] = "mx6qsabreauto_eimnor_config"
-         UBOOT_CONFIG[nand] = "mx6qsabreauto_nand_config,ubifs"
-         UBOOT_CONFIG[spinor] = "mx6qsabreauto_spinor_config"
-
-      In this example, "sd" is selected as the configuration of the possible four for the
-      :term:`UBOOT_MACHINE`. The "sd" configuration defines
-      "mx6qsabreauto_config" as the value for :term:`UBOOT_MACHINE`, while the
-      "sdcard" specifies the :term:`IMAGE_FSTYPES` to use for the U-Boot image.
+      Configures one or more U-Boot configurations to build. Each
+      configuration can define the :term:`UBOOT_MACHINE` and optionally the
+      :term:`IMAGE_FSTYPES` and the :term:`UBOOT_BINARY`.
+
+      Following is an example from the ``meta-freescale`` layer. ::
+
+         UBOOT_CONFIG ??= "sdcard-ifc-secure-boot sdcard-ifc sdcard-qspi lpuart qspi secure-boot nor"
+         UBOOT_CONFIG[nor] = "ls1021atwr_nor_defconfig"
+         UBOOT_CONFIG[sdcard-ifc] = "ls1021atwr_sdcard_ifc_defconfig,,u-boot-with-spl-pbl.bin"
+         UBOOT_CONFIG[sdcard-qspi] = "ls1021atwr_sdcard_qspi_defconfig,,u-boot-with-spl-pbl.bin"
+         UBOOT_CONFIG[lpuart] = "ls1021atwr_nor_lpuart_defconfig"
+         UBOOT_CONFIG[qspi] = "ls1021atwr_qspi_defconfig"
+         UBOOT_CONFIG[secure-boot] = "ls1021atwr_nor_SECURE_BOOT_defconfig"
+         UBOOT_CONFIG[sdcard-ifc-secure-boot] = "ls1021atwr_sdcard_ifc_SECURE_BOOT_defconfig,,u-boot-with-spl-pbl.bin"
+
+      In this example, all possible seven configurations are selected. Each
+      configuration specifies "..._defconfig" as :term:`UBOOT_MACHINE`, and
+      the "sd..." configurations define an individual name for
+      :term:`UBOOT_BINARY`. No configuration defines a second parameter for
+      :term:`IMAGE_FSTYPES` to use for the U-Boot image.
 
       For more information on how the :term:`UBOOT_CONFIG` is handled, see the
       :ref:`ref-classes-uboot-config` class.
Signature · 1 line
2.34.1
#7 lore raw

PATCH 7/7 migration-guide: add release notes for 4.3.2

In reply to [email protected]

From: Michael Opdenacker <[email protected]>

From: Lee Chee Yang <[email protected]>

---
 .../migration-guides/release-4.3.rst          |   1 +
 .../migration-guides/release-notes-4.3.2.rst  | 247 ++++++++++++++++++
 2 files changed, 248 insertions(+)
 create mode 100644 documentation/migration-guides/release-notes-4.3.2.rst
documentation/migration-guides/release-4.3.rst +1 -0
index 5b651a2efd..3adb5b620e 100644
@@ -8,3 +8,4 @@ Release 4.3 (nanbield)
    migration-4.3
    release-notes-4.3
    release-notes-4.3.1
+   release-notes-4.3.2
documentation/migration-guides/release-notes-4.3.2.rst new file +247 -0

247 lines not on this page · raw message

Signature · 1 line
2.34.1