diff options
Diffstat (limited to 'documentation/brief-yoctoprojectqs/index.rst')
| -rw-r--r-- | documentation/brief-yoctoprojectqs/index.rst | 61 |
1 files changed, 31 insertions, 30 deletions
diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst index 7ae0ddc349..c5400e4ac8 100644 --- a/documentation/brief-yoctoprojectqs/index.rst +++ b/documentation/brief-yoctoprojectqs/index.rst @@ -25,18 +25,11 @@ build a reference embedded OS called Poky. in the Yocto Project Development Tasks Manual for more information. - - You may use Windows Subsystem For Linux v2 to set up a build host - using Windows 10. - - .. note:: - - The Yocto Project is not compatible with WSLv1, it is - compatible but not officially supported nor validated with - WSLv2, if you still decide to use WSL please upgrade to WSLv2. - - See the :ref:`dev-manual/start:setting up to use windows - subsystem for linux (wslv2)` section in the Yocto Project Development - Tasks Manual for more information. + - You may use version 2 of Windows Subsystem For Linux (WSL 2) to set + up a build host using Windows 10 or later, Windows Server 2019 or later. + See the :ref:`dev-manual/start:setting up to use windows subsystem for + linux (wsl 2)` section in the Yocto Project Development Tasks Manual + for more information. If you want more conceptual or background information on the Yocto Project, see the :doc:`/overview-manual/index`. @@ -47,7 +40,13 @@ Compatible Linux Distribution Make sure your :term:`Build Host` meets the following requirements: -- 50 Gbytes of free disk space +- At least &MIN_DISK_SPACE; Gbytes of free disk space, though + much more will help to run multiple builds and increase + performance by reusing build artifacts. + +- At least &MIN_RAM; Gbytes of RAM, though a modern modern build host with as + much RAM and as many CPU cores as possible is strongly recommended to + maximize build performance. - Runs a supported Linux distribution (i.e. recent releases of Fedora, openSUSE, CentOS, Debian, or Ubuntu). For a list of Linux @@ -77,11 +76,9 @@ Build Host Packages You must install essential host packages on your build host. The following command installs the host packages based on an Ubuntu -distribution: +distribution:: -.. code-block:: shell - - $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL; + $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL; .. note:: @@ -231,13 +228,13 @@ an entire Linux distribution, including the toolchain, from source. Among other things, the script creates the :term:`Build Directory`, which is ``build`` in this case and is located in the :term:`Source Directory`. After - the script runs, your current working directory is set to the Build - Directory. Later, when the build completes, the Build Directory contains all the - files created during the build. + the script runs, your current working directory is set to the + :term:`Build Directory`. Later, when the build completes, the + :term:`Build Directory` contains all the files created during the build. #. **Examine Your Local Configuration File:** When you set up the build environment, a local configuration file named ``local.conf`` becomes - available in a ``conf`` subdirectory of the Build Directory. For this + available in a ``conf`` subdirectory of the :term:`Build Directory`. For this example, the defaults are set to build for a ``qemux86`` target, which is suitable for emulation. The package manager used is set to the RPM package manager. @@ -254,10 +251,16 @@ an entire Linux distribution, including the toolchain, from source. To use such mirrors, uncomment the below lines in your ``conf/local.conf`` file in the :term:`Build Directory`:: - BB_SIGNATURE_HANDLER = "OEEquivHash" + BB_HASHSERVE_UPSTREAM = "wss://hashserv.yoctoproject.org/ws" + SSTATE_MIRRORS ?= "file://.* http://cdn.jsdelivr.net/yocto/sstate/all/PATH;downloadfilename=PATH" BB_HASHSERVE = "auto" - BB_HASHSERVE_UPSTREAM = "hashserv.yocto.io:8687" - SSTATE_MIRRORS ?= "file://.* https://sstate.yoctoproject.org/all/PATH;downloadfilename=PATH" + BB_SIGNATURE_HANDLER = "OEEquivHash" + + The hash equivalence server needs the websockets python module version 9.1 + or later. Debian GNU/Linux 12 (Bookworm) and later, Fedora, CentOS Stream + 9 and later, and Ubuntu 22.04 (LTS) and later, all have a recent enough + package. Other supported distributions need to get the module some other + place than their package feed, e.g. via ``pip``. #. **Start the Build:** Continue with the following command to build an OS image for the target, which is ``core-image-sato`` in this example: @@ -269,7 +272,7 @@ an entire Linux distribution, including the toolchain, from source. For information on using the ``bitbake`` command, see the :ref:`overview-manual/concepts:bitbake` section in the Yocto Project Overview and Concepts Manual, or see - :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-intro:the bitbake command` + :ref:`bitbake-user-manual/bitbake-user-manual-intro:the bitbake command` in the BitBake User Manual. #. **Simulate Your Image Using QEMU:** Once this particular image is @@ -352,9 +355,7 @@ Follow these steps to add a hardware layer: #. **Add Your Layer to the Layer Configuration File:** Before you can use a layer during a build, you must add it to your ``bblayers.conf`` - file, which is found in the - :term:`Build Directory` ``conf`` - directory. + file, which is found in the :term:`Build Directory` ``conf`` directory. Use the ``bitbake-layers add-layer`` command to add the layer to the configuration file: @@ -370,7 +371,7 @@ Follow these steps to add a hardware layer: You can find more information on adding layers in the - :ref:`dev-manual/common-tasks:adding a layer using the \`\`bitbake-layers\`\` script` + :ref:`dev-manual/layers:adding a layer using the \`\`bitbake-layers\`\` script` section. Completing these steps has added the ``meta-altera`` layer to your Yocto @@ -405,7 +406,7 @@ The following commands run the tool to create a layer named For more information on layers and how to create them, see the -:ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script` +:ref:`dev-manual/layers:creating a general layer using the \`\`bitbake-layers\`\` script` section in the Yocto Project Development Tasks Manual. Where To Go Next |