documentation/brief-yoctoprojectqs/index.rst

1 .. SPDX-License-Identifier: CC-BY-SA-2.0-UK
17    -  The examples in this paper assume you are using a native Linux
18       system running a recent Ubuntu Linux distribution. If the machine
21       a native Linux system, you can still perform these steps by using
23       :ref:`dev-manual/start:setting up to use cross platforms (crops)`
28    -  You may use version 2 of Windows Subsystem For Linux (WSL 2) to set
30       See the :ref:`dev-manual/start:setting up to use windows subsystem for
35 Project, see the :doc:`/overview-manual/index`.
43 -  At least &MIN_DISK_SPACE; Gbytes of free disk space, though
47 -  At least &MIN_RAM; Gbytes of RAM, though a modern modern build host with as
51 -  Runs a supported Linux distribution (i.e. recent releases of Fedora,
52    openSUSE, CentOS, Debian, or Ubuntu). For a list of Linux
54    :ref:`ref-manual/system-requirements:supported linux distributions`
57    :ref:`dev-manual/start:preparing the build host`
60 -
62    -  Git &MIN_GIT_VERSION; or greater
63    -  tar &MIN_TAR_VERSION; or greater
64    -  Python &MIN_PYTHON_VERSION; or greater.
65    -  gcc &MIN_GCC_VERSION; or greater.
66    -  GNU make &MIN_MAKE_VERSION; or greater
69 requirements, you can take steps to prepare the system so that you
71 :ref:`ref-manual/system-requirements:required git, tar, python, make and gcc versions`
78 following command installs the host packages based on an Ubuntu
86    see the :ref:`ref-manual/system-requirements:required packages for the build host`
96 .. code-block:: shell
113 .. code-block:: shell
116    $ git branch -a
120    remotes/origin/HEAD -> origin/master
122    remotes/origin/dunfell-next
127    remotes/origin/gatesgarth-next
132    remotes/origin/master-next
138 For this example, check out the ``&DISTRO_NAME_NO_CAP;`` branch based on the
141 .. code-block:: shell
143    $ git checkout -t origin/&DISTRO_NAME_NO_CAP; -b my-&DISTRO_NAME_NO_CAP;
144 …Branch 'my-&DISTRO_NAME_NO_CAP;' set up to track remote branch '&DISTRO_NAME_NO_CAP;' from 'origin…
145    Switched to a new branch 'my-&DISTRO_NAME_NO_CAP;'
148 ``my-&DISTRO_NAME_NO_CAP;``. The files available to you in that branch
155 .. code-block:: shell
161 :ref:`dev-manual/start:locating yocto project source files`
172    -  If you are working behind a firewall and your build host is not
177    -  If you do not know your proxy settings, consult your local network
179       point could also be to check your web browser settings. Finally,
185    directory, run the :ref:`ref-manual/structure:\`\`oe-init-build-env\`\``
190    .. code-block:: shell
193       $ source oe-init-build-env
215           core-image-minimal
216           core-image-full-cmdline
217           core-image-sato
218           core-image-weston
219           meta-toolchain
220           meta-ide-support
222       You can also run generated QEMU images with a command like 'runqemu qemux86-64'
225        - 'devtool' and 'recipetool' handle common recipe tasks
226        - 'bitbake-layers' handles common layer tasks
227        - 'oe-pkgdata-util' handles common target package tasks
245       failures by using :ref:`overview-manual/concepts:shared state cache`
246       mirrors and enabling :ref:`overview-manual/concepts:hash equivalence`.
247       This way, you can use pre-built artifacts rather than building them.
261       9 and later, and Ubuntu 22.04 (LTS) and later, all have a recent enough
266    image for the target, which is ``core-image-sato`` in this example:
268    .. code-block:: shell
270       $ bitbake core-image-sato
273    :ref:`overview-manual/concepts:bitbake` section in the Yocto Project Overview and
275    :ref:`bitbake-user-manual/bitbake-user-manual-intro:the bitbake command`
282    .. code-block:: shell
284       $ runqemu qemux86-64
287    :ref:`dev-manual/qemu:using the quick emulator (qemu)` chapter in
291    ``Ctrl-C`` in the QEMU transcript window from which you evoked QEMU.
308    By convention, layer names start with the string "meta-".
315    `meta-altera <https://github.com/kraj/meta-altera>`__ hardware layer.
321    .. code-block:: shell
324       $ git clone https://github.com/kraj/meta-altera.git
325       Cloning into 'meta-altera'...
328       remote: Total 25170 (delta 645), reused 719 (delta 538), pack-reused 24219
335    host as ``meta-altera`` and contains all the metadata needed to
349    https://github.com/kraj/meta-altera/blob/master/conf/machine/cyclone5.conf.
360    Use the ``bitbake-layers add-layer`` command to add the layer to the
363    .. code-block:: shell
366       $ bitbake-layers add-layer ../meta-altera
374    :ref:`dev-manual/layers:adding a layer using the \`\`bitbake-layers\`\` script`
377 Completing these steps has added the ``meta-altera`` layer to your Yocto
392 ``bitbake-layers create-layer`` command. The tool automates layer
394 configuration file, a ``recipes-example`` subdirectory that contains an
398 ``meta-mylayer`` in the ``poky`` directory:
400 .. code-block:: shell
403    $ bitbake-layers create-layer meta-mylayer
405    Add your new layer with 'bitbake-layers add-layer meta-mylayer'
409 :ref:`dev-manual/layers:creating a general layer using the \`\`bitbake-layers\`\` script`
419 -  **Website:** The :yocto_home:`Yocto Project Website <>` provides
424 -  **Video Seminar:** The `Introduction to the Yocto Project and BitBake, Part 1
431 -  **Yocto Project Overview and Concepts Manual:** The
432    :doc:`/overview-manual/index` is a great
438 -  **Yocto Project Wiki:** The :yocto_wiki:`Yocto Project Wiki <>`
443 -  **Yocto Project Mailing Lists:** Related mailing lists provide a forum
446    :ref:`ref-manual/resources:mailing lists`
450 -  **Comprehensive List of Links and Other Documentation:** The
451    :ref:`ref-manual/resources:links and related documentation`