diff options
Diffstat (limited to 'poky/documentation/ref-manual')
| -rw-r--r-- | poky/documentation/ref-manual/classes.rst | 29 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/faq.rst | 17 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/system-requirements.rst | 10 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/tasks.rst | 8 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/terms.rst | 2 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/variables.rst | 57 |
6 files changed, 82 insertions, 41 deletions
diff --git a/poky/documentation/ref-manual/classes.rst b/poky/documentation/ref-manual/classes.rst index 5c60fd8c82..9b1ead66b3 100644 --- a/poky/documentation/ref-manual/classes.rst +++ b/poky/documentation/ref-manual/classes.rst @@ -590,19 +590,25 @@ Here is an example that uses this class in an image recipe:: " Here is an example that adds two users named "tester-jim" and "tester-sue" and assigns -passwords:: +passwords. First on host, create the password hash:: + + mkpasswd -m sha256crypt tester01 + +The resulting hash is set to a variable and used in ``useradd`` command parameters. +Remember to escape the character ``$``:: inherit extrausers + PASSWD = "\$X\$ABC123\$A-Long-Hash" EXTRA_USERS_PARAMS = "\ - useradd -P tester01 tester-jim; \ - useradd -P tester01 tester-sue; \ + useradd -p '${PASSWD}' tester-jim; \ + useradd -p '${PASSWD}' tester-sue; \ " -Finally, here is an example that sets the root password to "1876*18":: +Finally, here is an example that sets the root password:: inherit extrausers EXTRA_USERS_PARAMS = "\ - usermod -P 1876*18 root; \ + usermod -p '${PASSWD}' root; \ " .. _ref-classes-features_check: @@ -1494,15 +1500,6 @@ messages for various BitBake severity levels (i.e. ``bbplain``, This class is enabled by default since it is inherited by the ``base`` class. -.. _ref-classes-meta: - -``meta.bbclass`` -================ - -The ``meta`` class is inherited by recipes that do not build any output -packages themselves, but act as a "meta" target for building other -recipes. - .. _ref-classes-metadata_scm: ``metadata_scm.bbclass`` @@ -1600,7 +1597,7 @@ or other tools from the build host). You can create a recipe that builds tools that run natively on the host a couple different ways: -- Create a myrecipe\ ``-native.bb`` recipe that inherits the ``native`` +- Create a ``myrecipe-native.bb`` recipe that inherits the ``native`` class. If you use this method, you must order the inherit statement in the recipe after all other inherit statements so that the ``native`` class is inherited last. @@ -1642,7 +1639,7 @@ wish to build tools to run as part of an SDK (i.e. tools that run on You can create a recipe that builds tools that run on the SDK machine a couple different ways: -- Create a ``nativesdk-``\ myrecipe\ ``.bb`` recipe that inherits the +- Create a ``nativesdk-myrecipe.bb`` recipe that inherits the ``nativesdk`` class. If you use this method, you must order the inherit statement in the recipe after all other inherit statements so that the ``nativesdk`` class is inherited last. diff --git a/poky/documentation/ref-manual/faq.rst b/poky/documentation/ref-manual/faq.rst index d3a603d4a4..6f2970df23 100644 --- a/poky/documentation/ref-manual/faq.rst +++ b/poky/documentation/ref-manual/faq.rst @@ -143,7 +143,7 @@ various proxy types and configuring proxy servers, see the ":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`" Wiki page. -**Q:** What's the difference between target and target\ ``-native``? +**Q:** What's the difference between ``target`` and ``target-native``? **A:** The ``*-native`` targets are designed to run on the system being used for the build. These are usually tools that are needed to assist @@ -302,10 +302,10 @@ attempt before any others by adding something like the following to the ``local.conf`` configuration file:: PREMIRRORS:prepend = "\ - git://.*/.* http://www.yoctoproject.org/sources/ \n \ - ftp://.*/.* http://www.yoctoproject.org/sources/ \n \ - http://.*/.* http://www.yoctoproject.org/sources/ \n \ - https://.*/.* http://www.yoctoproject.org/sources/ \n" + git://.*/.* &YOCTO_DL_URL;/mirror/sources/ \n \ + ftp://.*/.* &YOCTO_DL_URL;/mirror/sources/ \n \ + http://.*/.* &YOCTO_DL_URL;/mirror/sources/ \n \ + https://.*/.* &YOCTO_DL_URL;/mirror/sources/ \n" These changes cause the build system to intercept Git, FTP, HTTP, and HTTPS requests and direct them to the ``http://`` sources mirror. You @@ -342,9 +342,10 @@ You could make the following changes to the ``local.conf`` configuration file as long as the :term:`PREMIRRORS` server is current:: PREMIRRORS:prepend = "\ - ftp://.*/.* http://www.yoctoproject.org/sources/ \n \ - http://.*/.* http://www.yoctoproject.org/sources/ \n \ - https://.*/.* http://www.yoctoproject.org/sources/ \n" + git://.*/.* &YOCTO_DL_URL;/mirror/sources/ \n \ + ftp://.*/.* &YOCTO_DL_URL;/mirror/sources/ \n \ + http://.*/.* &YOCTO_DL_URL;/mirror/sources/ \n \ + https://.*/.* &YOCTO_DL_URL;/mirror/sources/ \n" BB_FETCH_PREMIRRORONLY = "1" These changes would cause the build system to successfully fetch source diff --git a/poky/documentation/ref-manual/system-requirements.rst b/poky/documentation/ref-manual/system-requirements.rst index 5e5c105d62..d12e8dfbe3 100644 --- a/poky/documentation/ref-manual/system-requirements.rst +++ b/poky/documentation/ref-manual/system-requirements.rst @@ -120,23 +120,23 @@ supported Ubuntu or Debian Linux distribution: its own custom ``/usr/include/linux/soundcard.h`` on the Debian system. If you run into this situation, try either of these solutions:: - $ sudo apt-get build-dep qemu - $ sudo apt-get remove oss4-dev + $ sudo apt build-dep qemu + $ sudo apt remove oss4-dev - For Debian-8, ``python3-git`` and ``pylint3`` are no longer - available via ``apt-get``. + available via ``apt``. :: $ sudo pip3 install GitPython pylint==1.9.5 - *Essentials:* Packages needed to build an image on a headless system:: - $ sudo apt-get install &UBUNTU_HOST_PACKAGES_ESSENTIAL; + $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL; - *Documentation:* Packages needed if you are going to build out the Yocto Project documentation manuals:: - $ sudo apt-get install make python3-pip + $ sudo apt install make python3-pip &PIP3_HOST_PACKAGES_DOC; .. note:: diff --git a/poky/documentation/ref-manual/tasks.rst b/poky/documentation/ref-manual/tasks.rst index 4edae33392..299969dea4 100644 --- a/poky/documentation/ref-manual/tasks.rst +++ b/poky/documentation/ref-manual/tasks.rst @@ -516,17 +516,17 @@ scratch is guaranteed. $ bitbake -f -c do_cleansstate target -.. _ref-tasks-devpyshell: +.. _ref-tasks-pydevshell: -``do_devpyshell`` +``do_pydevshell`` ----------------- Starts a shell in which an interactive Python interpreter allows you to interact with the BitBake build environment. From within this shell, you can directly examine and set bits from the data store and execute -functions as if within the BitBake environment. See the ":ref:`dev-manual/common-tasks:using a development python shell`" section in +functions as if within the BitBake environment. See the ":ref:`dev-manual/common-tasks:using a python development shell`" section in the Yocto Project Development Tasks Manual for more information about -using ``devpyshell``. +using ``pydevshell``. .. _ref-tasks-devshell: diff --git a/poky/documentation/ref-manual/terms.rst b/poky/documentation/ref-manual/terms.rst index e5a7565df5..eccae91a1c 100644 --- a/poky/documentation/ref-manual/terms.rst +++ b/poky/documentation/ref-manual/terms.rst @@ -31,7 +31,7 @@ universal, the list includes them just in case: busybox_1.21.%.bbappend That append file - would match any ``busybox_1.21.``\ x\ ``.bb`` version of the recipe. So, + would match any ``busybox_1.21.x.bb`` version of the recipe. So, the append file would match any of the following recipe names: .. code-block:: shell diff --git a/poky/documentation/ref-manual/variables.rst b/poky/documentation/ref-manual/variables.rst index 5f6f91146b..b9e97719b9 100644 --- a/poky/documentation/ref-manual/variables.rst +++ b/poky/documentation/ref-manual/variables.rst @@ -730,7 +730,7 @@ system and gives an overview of their function and contents. Each configuration file you use must reside in the :term:`Build Directory` ``conf/multiconfig`` directory (e.g. - build_directory\ ``/conf/multiconfig/configA.conf``). + ``build_directory/conf/multiconfig/configA.conf``). For information on how to use :term:`BBMULTICONFIG` in an environment that supports building targets with multiple configurations, see the @@ -1582,6 +1582,23 @@ system and gives an overview of their function and contents. by :term:`BBFILE_PRIORITY` if that variable is different between two layers that contain different versions of the same recipe. + :term:`DEBUG_PREFIX_MAP` + Allows to set C compiler options, such as ``-fdebug-prefix-map``, + ``-fmacro-prefix-map``, and ``-ffile-prefix-map``, which allow to + replace build-time paths by install-time ones in the debugging sections + of binaries. This makes compiler output files location independent, + at the cost of having to pass an extra command to tell the debugger + where source files are. + + This is used by the Yocto Project to guarantee + :doc:`/test-manual/reproducible-builds` even when the source code of + a package uses the ``__FILE__`` or ``assert()`` macros. See the + `reproducible-builds.org <https://reproducible-builds.org/docs/build-path/>`__ + website for details. + + This variable is set in the ``meta/conf/bitbake.conf`` file. It is + not intended to be user-configurable. + :term:`DEFAULTTUNE` The default CPU and Application Binary Interface (ABI) tunings (i.e. the "tune") used by the OpenEmbedded build system. The @@ -5364,7 +5381,7 @@ system and gives an overview of their function and contents. so one of two ways: - *Append file:* Create an append file named - recipename\ ``.bbappend`` in your layer and override the value of + ``recipename.bbappend`` in your layer and override the value of :term:`PACKAGECONFIG`. You can either completely override the variable:: @@ -5838,10 +5855,10 @@ system and gives an overview of their function and contents. :term:`Build Directory`:: PREMIRRORS:prepend = "\ - git://.*/.* http://www.yoctoproject.org/sources/ \n \ - ftp://.*/.* http://www.yoctoproject.org/sources/ \n \ - http://.*/.* http://www.yoctoproject.org/sources/ \n \ - https://.*/.* http://www.yoctoproject.org/sources/ \n" + git://.*/.* &YOCTO_DL_URL;/mirror/sources/ \n \ + ftp://.*/.* &YOCTO_DL_URL;/mirror/sources/ \n \ + http://.*/.* &YOCTO_DL_URL;/mirror/sources/ \n \ + https://.*/.* &YOCTO_DL_URL;/mirror/sources/ \n" These changes cause the build system to intercept Git, FTP, HTTP, and HTTPS requests and @@ -6908,6 +6925,23 @@ system and gives an overview of their function and contents. You will see this variable referenced in the default values of ``FILES:${PN}-dev``. + :term:`SOURCE_DATE_EPOCH` + This defines a date expressed in number of seconds since + the UNIX EPOCH (01 Jan 1970 00:00:00 UTC), which is used by + multiple build systems to force a timestamp in built binaries. + Many upstream projects already support this variable. + + You will find more details in the `official specifications + <https://reproducible-builds.org/specs/source-date-epoch/>`__. + + A value for each recipe is computed from the sources by + :oe_git:`meta/lib/oe/reproducible.py </openembedded-core/tree/meta/lib/oe/reproducible.py>`. + + If a recipe wishes to override the default behavior, it should set its + own :term:`SOURCE_DATE_EPOCH` value:: + + SOURCE_DATE_EPOCH = "1613559011" + :term:`SOURCE_MIRROR_FETCH` When you are fetching files to create a mirror of sources (i.e. creating a source mirror), setting :term:`SOURCE_MIRROR_FETCH` to "1" in @@ -8141,6 +8175,15 @@ system and gives an overview of their function and contents. information on setting up a cross-development environment, see the :doc:`/sdk-manual/index` manual. + Note that this variable applies to building an SDK, not an eSDK, + in which case the term:`TOOLCHAIN_HOST_TASK_ESDK` setting should be + used instead. + + :term:`TOOLCHAIN_HOST_TASK_ESDK` + This variable allows to extend what is installed in the host + portion of an eSDK. This is similar to :term:`TOOLCHAIN_HOST_TASK` + applying to SDKs. + :term:`TOOLCHAIN_OUTPUTNAME` This variable defines the name used for the toolchain output. The :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class sets @@ -8745,7 +8788,7 @@ system and gives an overview of their function and contents. :term:`WKS_FILE` Specifies the location of the Wic kickstart file that is used by the OpenEmbedded build system to create a partitioned image - (image\ ``.wic``). For information on how to create a partitioned + (``image.wic``). For information on how to create a partitioned image, see the ":ref:`dev-manual/common-tasks:creating partitioned images using wic`" section in the Yocto Project Development Tasks Manual. For details on |