overview-manual: Updated "Patching" section.

This section presents a deep dive into the patching phase of the
build process.  I removed the vague "apply=yes" reference and added
more references for the reader to read and learn about patching.

The bit about the SRC_URI parameters (i.e. "apply") is going to be
covered in the do_patch documentation since that is the task that
handles that stuff.

(From yocto-docs rev: 5a2c98543ccc9ed24d16bb9442b674532940c0da)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2018-05-03 08:10:37 -07:00
committed by Richard Purdie
parent 03a7ed331d
commit 02f9805957

View File

@@ -1239,22 +1239,25 @@
</para>
<para>
The
<ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-patch'><filename>do_patch</filename></ulink>
task processes recipes by using the
The <filename>do_patch</filename> task processes recipes by
using the
<ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink>
variable to locate applicable patch files, which by default
are <filename>*.patch</filename> or
<filename>*.diff</filename> files, or any file if
"apply=yes" is specified for the file in
<filename>SRC_URI</filename>.
variable to locate applicable patch files.
Default processing for patch files assumes the files have
either <filename>*.patch</filename> or
<filename>*.diff</filename> endings.
You can use <filename>SRC_URI</filename> parameters to
change the way the build system recognizes patch files.
See the
<ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-patch'><filename>do_patch</filename></ulink>
task for more information.
</para>
<para>
BitBake finds and applies multiple patches for a single
recipe in the order in which it finds the patches.
Patches are applied to the recipe's source files located
in the
recipe in the order in which it locates the patches.
Patches are applied to the recipe's source files, which
are located in the
<ulink url='&YOCTO_DOCS_REF_URL;#var-S'><filename>S</filename></ulink>
directory.
</para>
@@ -1264,6 +1267,18 @@
created, see the
"<link linkend='source-fetching-dev-environment'>Source Fetching</link>"
section.
For more information on how to create patches and how the
build system processes patches, see the
"<ulink url='&YOCTO_DOCS_DEV_URL;#new-recipe-patching-code'>Patching Code</ulink>"
section in the Yocto Project Development Tasks Manual.
You can also see the
"<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-devtool-use-devtool-modify-to-modify-the-source-of-an-existing-component'>Use <filename>devtool modify</filename> to Modify the Source of an Existing Component</ulink>"
section in the Yocto Project Application Development and
the Extensible Software Development Kit (SDK) manual and
the
"<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#using-traditional-kernel-development-to-patch-the-kernel'>Using Traditional Kernel Development to Patch the Kernel</ulink>"
section in the Yocto Project Linux Kernel Development
Manual.
</para>
</section>