summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-05-04 05:31:54 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-05-24 17:16:30 +0100
commit445e13ae352a21f1a77d9f5ba9837252b507bcfb (patch)
treebde1a2f3adaccc92825ad6ebd2909d4f419c8552 /documentation
parent47b7dcd3450358f483548cdb35cbe71bded616b7 (diff)
downloadpoky-445e13ae352a21f1a77d9f5ba9837252b507bcfb.tar.gz
ref-manual: Review edits added to do_patch task
Mentioned the role of SRC_URI earlier in the description as it is key. Replaced "some_recipe" with "some_package" as the emphisis is not on the recipe at that point in the example. (From yocto-docs rev: f7f86941fdf866a693386335374f835078db3ddf) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/ref-tasks.xml23
1 files changed, 15 insertions, 8 deletions
diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml
index 93ad692775..e6cf68670b 100644
--- a/documentation/ref-manual/ref-tasks.xml
+++ b/documentation/ref-manual/ref-tasks.xml
@@ -432,8 +432,16 @@
432 </para> 432 </para>
433 433
434 <para> 434 <para>
435 After fetching and unpacking source files, the build system locates 435 After fetching and unpacking source files, the build system
436 and applies patches to the source code. 436 uses the recipe's
437 <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink>
438 statements to locate and apply patch files to the source code.
439 <note>
440 The build system uses the
441 <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESPATH'><filename>FILESPATH</filename></ulink>
442 variable to determine the default set of directories when
443 searching for patches.
444 </note>
437 Patch files, by default, are <filename>*.patch</filename> and 445 Patch files, by default, are <filename>*.patch</filename> and
438 <filename>*.diff</filename> files created and kept in a 446 <filename>*.diff</filename> files created and kept in a
439 subdirectory of the directory holding the recipe file. 447 subdirectory of the directory holding the recipe file.
@@ -451,10 +459,9 @@
451 </para> 459 </para>
452 460
453 <para> 461 <para>
454 The recipe for <filename>bluez5</filename> uses the 462 In the <filename>bluez5</filename> recipe, the
455 <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink> 463 <filename>SRC_URI</filename> statements point to the source and
456 variable to point to the source and patch files needed to build 464 patch files needed to build the package.
457 the recipe.
458 <note> 465 <note>
459 In the case for the <filename>bluez5_5.48.bb</filename> 466 In the case for the <filename>bluez5_5.48.bb</filename>
460 recipe, the <filename>SRC_URI</filename> statements are from an 467 recipe, the <filename>SRC_URI</filename> statements are from an
@@ -471,7 +478,7 @@
471 patch file: 478 patch file:
472 <literallayout class='monospaced'> 479 <literallayout class='monospaced'>
473 SRC_URI = " \ 480 SRC_URI = " \
474 git://<replaceable>path_to_repo</replaceable>/<replaceable>some_recipe</replaceable> \ 481 git://<replaceable>path_to_repo</replaceable>/<replaceable>some_package</replaceable> \
475 file://<replaceable>file</replaceable>;apply=yes \ 482 file://<replaceable>file</replaceable>;apply=yes \
476 " 483 "
477 </literallayout> 484 </literallayout>
@@ -485,7 +492,7 @@
485 statement: 492 statement:
486 <literallayout class='monospaced'> 493 <literallayout class='monospaced'>
487 SRC_URI = " \ 494 SRC_URI = " \
488 git://<replaceable>path_to_repo</replaceable>/<replaceable>some_recipe</replaceable> \ 495 git://<replaceable>path_to_repo</replaceable>/<replaceable>some_package</replaceable> \
489 file://<replaceable>path_to_lots_of_patch_files</replaceable> \ 496 file://<replaceable>path_to_lots_of_patch_files</replaceable> \
490 file://<replaceable>path_to_lots_of_patch_files</replaceable>/<replaceable>patch_file5</replaceable>;apply=no \ 497 file://<replaceable>path_to_lots_of_patch_files</replaceable>/<replaceable>patch_file5</replaceable>;apply=no \
491 " 498 "