summaryrefslogtreecommitdiff
path: root/poky/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'poky/documentation')
-rw-r--r--poky/documentation/dev-manual/dev-manual-common-tasks.xml3
-rw-r--r--poky/documentation/overview-manual/overview-manual.xml5
-rw-r--r--poky/documentation/ref-manual/ref-variables.xml5
-rw-r--r--poky/documentation/sdk-manual/sdk-extensible.xml85
4 files changed, 82 insertions, 16 deletions
diff --git a/poky/documentation/dev-manual/dev-manual-common-tasks.xml b/poky/documentation/dev-manual/dev-manual-common-tasks.xml
index 9231d1416e..165c3aa6a7 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/overview-manual/overview-manual.xml b/poky/documentation/overview-manual/overview-manual.xml
index e74ba8d5c2..728cad57f3 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/ref-manual/ref-variables.xml b/poky/documentation/ref-manual/ref-variables.xml
index 12876e3d9a..0080364e4f 100644
--- a/poky/documentation/ref-manual/ref-variables.xml
+++ b/poky/documentation/ref-manual/ref-variables.xml
@@ -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>
@@ -11694,8 +11694,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 bd5278493f..94d2a241fe 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>