diff options
Diffstat (limited to 'poky/documentation')
| -rw-r--r-- | poky/documentation/dev-manual/common-tasks.rst | 6 | ||||
| -rw-r--r-- | poky/documentation/overview-manual/concepts.rst | 4 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/qa-checks.rst | 4 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/variables.rst | 71 | ||||
| -rw-r--r-- | poky/documentation/releases.rst | 1 | ||||
| -rw-r--r-- | poky/documentation/sphinx-static/switchers.js | 2 |
6 files changed, 56 insertions, 32 deletions
diff --git a/poky/documentation/dev-manual/common-tasks.rst b/poky/documentation/dev-manual/common-tasks.rst index bd8bbecb3d..b81f51bf83 100644 --- a/poky/documentation/dev-manual/common-tasks.rst +++ b/poky/documentation/dev-manual/common-tasks.rst @@ -3888,6 +3888,12 @@ Follow these steps to create an initramfs image: .. note:: + Bundling the initramfs with the kernel conflates the code in the initramfs + with the GPLv2 licensed Linux kernel binary. Thus only GPLv2 compatible + software may be part of a bundled initramfs. + + .. note:: + If you choose to not bundle the initramfs image with the kernel image, you are essentially using an `Initial RAM Disk (initrd) <https://en.wikipedia.org/wiki/Initrd>`__. diff --git a/poky/documentation/overview-manual/concepts.rst b/poky/documentation/overview-manual/concepts.rst index c8b89885e3..3017637529 100644 --- a/poky/documentation/overview-manual/concepts.rst +++ b/poky/documentation/overview-manual/concepts.rst @@ -1908,8 +1908,8 @@ Behind the scenes, the shared state code works by looking in shared state files. Here is an example:: SSTATE_MIRRORS ?= "\ - file://.\* http://someserver.tld/share/sstate/PATH;downloadfilename=PATH \n \ - file://.\* file:///some/local/dir/sstate/PATH" + file://.* http://someserver.tld/share/sstate/PATH;downloadfilename=PATH \n \ + file://.* file:///some/local/dir/sstate/PATH" .. note:: diff --git a/poky/documentation/ref-manual/qa-checks.rst b/poky/documentation/ref-manual/qa-checks.rst index c3e40dba5e..792c099d0c 100644 --- a/poky/documentation/ref-manual/qa-checks.rst +++ b/poky/documentation/ref-manual/qa-checks.rst @@ -151,7 +151,7 @@ Errors and Warnings occur if you add a path which contains a ``.debug`` directory and do not explicitly add the ``.debug`` directory to the ``-dbg`` package. If this is the case, add the ``.debug`` directory explicitly to - ``FILES_${PN}-dbg``. See :term:`FILES` for additional + ``FILES:${PN}-dbg``. See :term:`FILES` for additional information on :term:`FILES`. @@ -435,7 +435,7 @@ Errors and Warnings (e.g. :term:`PN` happens to be the same as :term:`MACHINE` or :term:`DISTRO`), it can have unexpected consequences. For example, assignments such as - ``FILES_${PN} = "xyz"`` effectively turn into ``FILES = "xyz"``. + ``FILES:${PN} = "xyz"`` effectively turn into ``FILES = "xyz"``. Rename your recipe (or if :term:`PN` is being set explicitly, change the :term:`PN` value) so that the conflict does not occur. See :term:`FILES` for additional information. diff --git a/poky/documentation/ref-manual/variables.rst b/poky/documentation/ref-manual/variables.rst index dbe02ab27a..5f6f91146b 100644 --- a/poky/documentation/ref-manual/variables.rst +++ b/poky/documentation/ref-manual/variables.rst @@ -3589,6 +3589,12 @@ system and gives an overview of their function and contents. .. note:: + Bundling the initramfs with the kernel conflates the code in the + initramfs with the GPLv2 licensed Linux kernel binary. Thus only GPLv2 + compatible software may be part of a bundled initramfs. + + .. note:: + Using an extra compilation pass to bundle the initramfs avoids a circular dependency between the kernel recipe and the initramfs recipe should the initramfs include kernel modules. Should that be @@ -5064,33 +5070,44 @@ system and gives an overview of their function and contents. ":ref:`package.bbclass <ref-classes-package>`" section. :term:`PACKAGE_DEBUG_SPLIT_STYLE` - Determines how to split up the binary and debug information when - creating ``*-dbg`` packages to be used with the GNU Project Debugger - (GDB). - - With the :term:`PACKAGE_DEBUG_SPLIT_STYLE` variable, you can control - where debug information, which can include or exclude source files, - is stored: - - - ".debug": Debug symbol files are placed next to the binary in a - ``.debug`` directory on the target. For example, if a binary is - installed into ``/bin``, the corresponding debug symbol files are - installed in ``/bin/.debug``. Source files are placed in - ``/usr/src/debug``. - - - "debug-file-directory": Debug symbol files are placed under - ``/usr/lib/debug`` on the target, and separated by the path from - where the binary is installed. For example, if a binary is - installed in ``/bin``, the corresponding debug symbols are - installed in ``/usr/lib/debug/bin``. Source files are placed in - ``/usr/src/debug``. - - - "debug-without-src": The same behavior as ".debug" previously - described with the exception that no source files are installed. - - - "debug-with-srcpkg": The same behavior as ".debug" previously - described with the exception that all source files are placed in a - separate ``*-src`` pkg. This is the default behavior. + Determines how to split up and package debug and source information + when creating debugging packages to be used with the GNU Project + Debugger (GDB). In general, based on the value of this variable, + you can combine the source and debug info in a single package, + you can break out the source into a separate package that can be + installed independently, or you can choose to not have the source + packaged at all. + + The possible values of :term:`PACKAGE_DEBUG_SPLIT_STYLE` variable: + + - "``.debug``": All debugging and source info is placed in a single + ``*-dbg`` package; debug symbol files are placed next to the + binary in a ``.debug`` directory so that, if a binary is installed + into ``/bin``, the corresponding debug symbol file is installed + in ``/bin/.debug``. Source files are installed in the same ``*-dbg`` + package under ``/usr/src/debug``. + + - "``debug-file-directory``": As above, all debugging and source info + is placed in a single ``*-dbg`` package; debug symbol files are + placed entirely under the directory ``/usr/lib/debug`` and separated + by the path from where the binary is installed, so that if a binary + is installed in ``/bin``, the corresponding debug symbols are installed + in ``/usr/lib/debug/bin``, and so on. As above, source is installed + in the same package under ``/usr/src/debug``. + + - "``debug-with-srcpkg``": Debugging info is placed in the standard + ``*-dbg`` package as with the ``.debug`` value, while source is + placed in a separate ``*-src`` package, which can be installed + independently. This is the default setting for this variable, + as defined in Poky's ``bitbake.conf`` file. + + - "``debug-without-src``": The same behavior as with the ``.debug`` + setting, but no source is packaged at all. + + .. note:: + + Much of the above package splitting can be overridden via + use of the :term:`INHIBIT_PACKAGE_DEBUG_SPLIT` variable. You can find out more about debugging using GDB by reading the ":ref:`dev-manual/common-tasks:debugging with the gnu project debugger (gdb) remotely`" section diff --git a/poky/documentation/releases.rst b/poky/documentation/releases.rst index 436f20a29d..bb881a2e24 100644 --- a/poky/documentation/releases.rst +++ b/poky/documentation/releases.rst @@ -38,6 +38,7 @@ Release Series 3.1 (dunfell) - :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>` ========================== Outdated Release Manuals diff --git a/poky/documentation/sphinx-static/switchers.js b/poky/documentation/sphinx-static/switchers.js index a693fefb0c..1e37b625a6 100644 --- a/poky/documentation/sphinx-static/switchers.js +++ b/poky/documentation/sphinx-static/switchers.js @@ -5,7 +5,7 @@ 'dev': 'dev (3.4)', '3.3.3': '3.3.3', '3.2.4': '3.2.4', - '3.1.10': '3.1.10', + '3.1.11': '3.1.11', '3.0.4': '3.0.4', '2.7.4': '2.7.4', }; |