diff options
Diffstat (limited to 'poky/documentation')
| -rw-r--r-- | poky/documentation/dev-manual/dev-manual-common-tasks.xml | 3 | ||||
| -rw-r--r-- | poky/documentation/dev-manual/dev-manual-start.xml | 5 | ||||
| -rw-r--r-- | poky/documentation/overview-manual/overview-manual.xml | 5 | ||||
| -rw-r--r-- | poky/documentation/poky.ent | 2 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/ref-classes.xml | 32 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/ref-devtool-reference.xml | 12 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/ref-features.xml | 21 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/ref-system-requirements.xml | 1 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/ref-variables.xml | 23 | ||||
| -rw-r--r-- | poky/documentation/sdk-manual/sdk-extensible.xml | 85 |
10 files changed, 99 insertions, 90 deletions
diff --git a/poky/documentation/dev-manual/dev-manual-common-tasks.xml b/poky/documentation/dev-manual/dev-manual-common-tasks.xml index 9231d1416..165c3aa6a 100644 --- a/poky/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/poky/documentation/dev-manual/dev-manual-common-tasks.xml @@ -7129,7 +7129,8 @@ This problem is solved with the OpenEmbedded build system by running the code through QEMU, which allows precisely that. Unfortunately, QEMU does not always work perfectly as mentioned - in the xxx section. + in the + "<link linkend='known-issues'>Known Issues</link>" section. </para> <section id='enabling-the-generation-of-introspection-data'> diff --git a/poky/documentation/dev-manual/dev-manual-start.xml b/poky/documentation/dev-manual/dev-manual-start.xml index 5625dfcdd..59ffa49bb 100644 --- a/poky/documentation/dev-manual/dev-manual-start.xml +++ b/poky/documentation/dev-manual/dev-manual-start.xml @@ -23,9 +23,8 @@ It might not be immediately clear how you can use the Yocto Project in a team development environment, or how to scale it for a large team of developers. - One of the strengths of the Yocto Project is that it is extremely - flexible. - Thus, you can adapt it to many different use cases and scenarios. + You can adapt the Yocto Project to many different use cases and + scenarios. However, this flexibility could cause difficulties if you are trying to create a working setup that scales across a large team. </para> diff --git a/poky/documentation/overview-manual/overview-manual.xml b/poky/documentation/overview-manual/overview-manual.xml index e74ba8d5c..728cad57f 100644 --- a/poky/documentation/overview-manual/overview-manual.xml +++ b/poky/documentation/overview-manual/overview-manual.xml @@ -37,6 +37,11 @@ <revremark>The initial document released with the Yocto Project 2.5 Release.</revremark> </revision> <revision> + <revnumber>2.6</revnumber> + <date>November 2018</date> + <revremark>Released with the Yocto Project 2.7 Release.</revremark> + </revision> + <revision> <revnumber>2.7</revnumber> <date>May 2019</date> <revremark>Released with the Yocto Project 2.7 Release.</revremark> diff --git a/poky/documentation/poky.ent b/poky/documentation/poky.ent index b5f600969..192b9418f 100644 --- a/poky/documentation/poky.ent +++ b/poky/documentation/poky.ent @@ -60,7 +60,7 @@ <!ENTITY UBUNTU_HOST_PACKAGES_ESSENTIAL "gawk wget git-core diffstat unzip texinfo gcc-multilib \ build-essential chrpath socat cpio python python3 python3-pip python3-pexpect \ xz-utils debianutils iputils-ping python3-git python3-jinja2 libegl1-mesa libsdl1.2-dev \ - xterm"> + pylint3 xterm"> <!ENTITY FEDORA_HOST_PACKAGES_ESSENTIAL "gawk make wget tar bzip2 gzip python3 unzip perl patch \ diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath \ ccache perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue perl-bignum socat \ diff --git a/poky/documentation/ref-manual/ref-classes.xml b/poky/documentation/ref-manual/ref-classes.xml index ece47e757..5403f20b6 100644 --- a/poky/documentation/ref-manual/ref-classes.xml +++ b/poky/documentation/ref-manual/ref-classes.xml @@ -318,23 +318,6 @@ </para> </section> -<section id='ref-classes-bluetooth'> - <title><filename>bluetooth.bbclass</filename></title> - - <para> - The <filename>bluetooth</filename> class defines a variable that - expands to the recipe (package) providing core - bluetooth support on the platform. - </para> - - <para> - For details on how the class works, see the - <filename>meta/classes/bluetooth.bbclass</filename> file in the Yocto - Project - <link linkend='source-directory'>Source Directory</link>. - </para> -</section> - <section id='ref-classes-buildhistory'> <title><filename>buildhistory.bbclass</filename></title> @@ -937,21 +920,6 @@ </para> </section> -<section id='ref-classes-gnome'> - <title><filename>gnome.bbclass</filename></title> - - <para> - The <filename>gnome</filename> class supports recipes that - build software from the GNOME stack. - This class inherits the - <link linkend='ref-classes-gnomebase'><filename>gnomebase</filename></link>, - <link linkend='ref-classes-gtk-icon-cache'><filename>gtk-icon-cache</filename></link>, - <link linkend='ref-classes-gconf'><filename>gconf</filename></link> and - <link linkend='ref-classes-mime'><filename>mime</filename></link> classes. - The class also disables GObject introspection where applicable. - </para> -</section> - <section id='ref-classes-gnomebase'> <title><filename>gnomebase.bbclass</filename></title> diff --git a/poky/documentation/ref-manual/ref-devtool-reference.xml b/poky/documentation/ref-manual/ref-devtool-reference.xml index 4810d28ad..11f7399c5 100644 --- a/poky/documentation/ref-manual/ref-devtool-reference.xml +++ b/poky/documentation/ref-manual/ref-devtool-reference.xml @@ -629,18 +629,18 @@ <title>Building Your Recipe</title> <para> - Use the <filename>devtool build</filename> command to cause the - OpenEmbedded build system to build your recipe. + Use the <filename>devtool build</filename> command to build your + recipe. The <filename>devtool build</filename> command is equivalent to - <filename>bitbake -c populate_sysroot</filename>. + the <filename>bitbake -c populate_sysroot</filename> command. </para> <para> When you use the <filename>devtool build</filename> command, - you must supply the root name of the recipe (i.e. no version, - paths, or extensions). + you must supply the root name of the recipe (i.e. do not provide + versions, paths, or extensions). You can use either the "-s" or the "--disable-parallel-make" - option to disable parallel makes during the build. + options to disable parallel makes during the build. Here is an example: <literallayout class='monospaced'> $ devtool build <replaceable>recipe</replaceable> diff --git a/poky/documentation/ref-manual/ref-features.xml b/poky/documentation/ref-manual/ref-features.xml index b057d2d04..44ba67cf5 100644 --- a/poky/documentation/ref-manual/ref-features.xml +++ b/poky/documentation/ref-manual/ref-features.xml @@ -154,27 +154,6 @@ </para></listitem> <listitem><para><emphasis>bluetooth:</emphasis> Include bluetooth support (integrated BT only).</para></listitem> - <listitem><para><emphasis>bluez5:</emphasis> Include - BlueZ Version 5, which provides core Bluetooth layers and - protocols support. - <note> - The default value for the - <filename>DISTRO FEATURES</filename> variable includes - "bluetooth", which causes bluez5 to be backfilled in - for bluetooth support. - If you do not want bluez5 backfilled and would rather - use bluez4, you need to use the - <link linkend='var-DISTRO_FEATURES_BACKFILL_CONSIDERED'><filename>DISTRO_FEATURES_BACKFILL_CONSIDERED</filename></link> - variable as follows: - <literallayout class='monospaced'> - DISTRO_FEATURES_BACKFILL_CONSIDERED = "bluez5" - </literallayout> - Setting this variable tells the OpenEmbedded build - system that you have considered but ruled - out using the bluez5 feature and that bluez4 will be - used. - </note> - </para></listitem> <listitem><para><emphasis>cramfs:</emphasis> Include CramFS support.</para></listitem> <listitem><para><emphasis>directfb:</emphasis> diff --git a/poky/documentation/ref-manual/ref-system-requirements.xml b/poky/documentation/ref-manual/ref-system-requirements.xml index 239dd84bb..51995309d 100644 --- a/poky/documentation/ref-manual/ref-system-requirements.xml +++ b/poky/documentation/ref-manual/ref-system-requirements.xml @@ -95,6 +95,7 @@ <listitem><para>CentOS 7.x</para></listitem> <listitem><para>Debian GNU/Linux 8.x (Jessie)</para></listitem> <listitem><para>Debian GNU/Linux 9.x (Stretch)</para></listitem> + <listitem><para>Debian GNU/Linux 10.x (Buster)</para></listitem> <listitem><para>OpenSUSE 42.3</para></listitem> </itemizedlist> </para> diff --git a/poky/documentation/ref-manual/ref-variables.xml b/poky/documentation/ref-manual/ref-variables.xml index 12876e3d9..93b758838 100644 --- a/poky/documentation/ref-manual/ref-variables.xml +++ b/poky/documentation/ref-manual/ref-variables.xml @@ -335,7 +335,7 @@ <glossdef> <para role="glossdeffirst"> <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The minimal command and arguments used to run the + Minimal command and arguments needed to run the assembler. </para> </glossdef> @@ -1358,7 +1358,7 @@ For example, the following line specifies three configuration files: <literallayout class='monospaced'> - BBMULTIFONFIG = "configA configB configC" + BBMULTICONFIG = "configA configB configC" </literallayout> Each configuration file you use must reside in the <link linkend='build-directory'>Build Directory</link> @@ -6606,6 +6606,7 @@ by default: <literallayout class='monospaced'> btrfs + container cpio cpio.gz cpio.lz4 @@ -6621,13 +6622,14 @@ ext3.gz ext4 ext4.gz - hdddirect + f2fs hddimg iso jffs2 jffs2.sum multiubi squashfs + squashfs-lz4 squashfs-lzo squashfs-xz tar @@ -7580,15 +7582,9 @@ However, providing just the <filename>.dtb</filename> file is preferred. </note> - In order to use this variable, you must have the include - files in your kernel recipe: - <literallayout class='monospaced'> - require recipes-kernel/linux/linux-dtb.inc - </literallayout> - or - <literallayout class='monospaced'> - require recipes-kernel/linux/linux-yocto.inc - </literallayout> + In order to use this variable, the + <link linkend='ref-classes-kernel-devicetree'><filename>kernel-devicetree</filename></link> + class must be inherited. </para> </glossdef> </glossentry> @@ -11694,8 +11690,7 @@ or <link linkend='ref-classes-setuptools'><filename>setuptools</filename></link> classes, specifies the major Python version being built. - For Python 2.x, <filename>PYTHON_PN</filename> would - be "python2". For Python 3.x, the variable would be + For Python 3.x, <filename>PYTHON_PN</filename> would be "python3". You do not have to set this variable as the OpenEmbedded build system automatically sets it for you. diff --git a/poky/documentation/sdk-manual/sdk-extensible.xml b/poky/documentation/sdk-manual/sdk-extensible.xml index bd5278493..94d2a241f 100644 --- a/poky/documentation/sdk-manual/sdk-extensible.xml +++ b/poky/documentation/sdk-manual/sdk-extensible.xml @@ -618,7 +618,23 @@ The result is that the command sets up both the source code and an append file within the workspace while the recipe remains in its - original location. + original location.</para> + + <para>Additionally, if you have any non-patch + local files (i.e. files referred to with + <filename>file://</filename> entries in + <filename>SRC_URI</filename> statement excluding + <filename>*.patch/</filename> or + <filename>*.diff</filename>), these files are + copied to an + <filename>oe-local-files</filename> folder + under the newly created source tree. + Copying the files here gives you a convenient + area from which you can modify the files. + Any changes or additions you make to those + files are incorporated into the build the next + time you build the software just as are other + changes you might have made to the source. </para></listitem> <listitem><para> <emphasis>Middle</emphasis>: @@ -633,10 +649,10 @@ </para> <para>The following command tells - <filename>devtool</filename> what recipe with + <filename>devtool</filename> the recipe with which to work and, in this case, identifies a local area for the extracted source files that - is outside of the default + exists outside of the default <filename>devtool</filename> workspace: <literallayout class='monospaced'> $ devtool modify <replaceable>recipe srctree</replaceable> @@ -650,8 +666,12 @@ the recipe's <filename>SRC_URI</filename> statements to locate the source files and any associated patch files. - Once the files are located, the command by - default extracts them into + Non-patch files are copied to an + <filename>oe-local-files</filename> folder + under the newly created source tree.</para> + + <para>Once the files are located, the command + by default extracts them into <replaceable>srctree</replaceable>.</para> <para>Within workspace, @@ -685,9 +705,21 @@ </literallayout> </para> - <para>Once the command finishes, it creates only - an append file for the recipe in the - <filename>devtool</filename> workspace. + <para>If an <filename>oe-local-files</filename> + subdirectory happens to exist and it contains + non-patch files, the files are used. + However, if the subdirectory does not exist and + you run the <filename>devtool finish</filename> + command, any non-patch files that might exist + next to the recipe are removed because it + appears to <filename>devtool</filename> that + you have deleted those files.</para> + + <para>Once the + <filename>devtool modify</filename> command + finishes, it creates only an append file for + the recipe in the <filename>devtool</filename> + workspace. The recipe and the source code remain in their original locations. </para></listitem> @@ -778,7 +810,12 @@ original recipe in the original layer or the command creates a <filename>.bbappend</filename> file in a different layer as provided by - <replaceable>layer</replaceable>.</para> + <replaceable>layer</replaceable>. + Any work you did in the + <filename>oe-local-files</filename> directory is + preserved in the original files next to the recipe + during the <filename>devtool finish</filename> + command.</para> <para>As a final process of the <filename>devtool finish</filename> command, the state @@ -898,7 +935,23 @@ files from other developers. The result is that the command sets up the source code, the new version of the recipe, and an append file - all within the workspace. + all within the workspace.</para> + + <para>Additionally, if you have any non-patch + local files (i.e. files referred to with + <filename>file://</filename> entries in + <filename>SRC_URI</filename> statement excluding + <filename>*.patch/</filename> or + <filename>*.diff</filename>), these files are + copied to an + <filename>oe-local-files</filename> folder + under the newly created source tree. + Copying the files here gives you a convenient + area from which you can modify the files. + Any changes or additions you make to those + files are incorporated into the build the next + time you build the software just as are other + changes you might have made to the source. </para></listitem> <listitem><para> <emphasis>Resolve any Conflicts created by the Upgrade</emphasis>: @@ -976,10 +1029,18 @@ Git repository, moves the new recipe to a more permanent layer, and then resets the recipe so that the recipe is built normally rather than from the - workspace. + workspace.</para> + + <para>Any work you did in the + <filename>oe-local-files</filename> directory is + preserved in the original files next to the recipe + during the <filename>devtool finish</filename> + command.</para> + + <para> If you specify a destination layer that is the same as the original source, then the old version of the - recipe and associated files will be removed prior to + recipe and associated files are removed prior to adding the new version. <literallayout class='monospaced'> $ devtool finish <replaceable>recipe layer</replaceable> |