[v2] ref-manual: fix patch documentation

Message ID 20220103195050.466-1-max.krummenacher@toradex.com
State New
Headers show
Series [v2] ref-manual: fix patch documentation | expand

Commit Message

Max Krummenacher Jan. 3, 2022, 7:50 p.m. UTC
The do_patch implementation does not apply patches from an entry in
SRC_URI pointing to a directory.
Remove the claim that this is implemented.

Signed-off-by: Max Krummenacher <max.krummenacher@toradex.com>
---
 documentation/ref-manual/tasks.rst | 16 +++++++---------
 1 file changed, 7 insertions(+), 9 deletions(-)

Changes v2:
- Reworked according to Quentin Schulz's feedback

Comments

Quentin Schulz Jan. 4, 2022, 8:17 a.m. UTC | #1
Hi Max,

On 1/3/22 20:50, Max Krummenacher wrote:
> The do_patch implementation does not apply patches from an entry in
> SRC_URI pointing to a directory.
> Remove the claim that this is implemented.
> 
> Signed-off-by: Max Krummenacher <max.krummenacher@toradex.com>

Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>

As a side note, this patch is a candidate for backports to currently 
maintained releases.

Thanks!
Quentin
Michael Opdenacker Jan. 4, 2022, 10:14 a.m. UTC | #2
On 1/4/22 9:17 AM, Quentin Schulz wrote:
> Hi Max,
>
> On 1/3/22 20:50, Max Krummenacher wrote:
>> The do_patch implementation does not apply patches from an entry in
>> SRC_URI pointing to a directory.
>> Remove the claim that this is implemented.
>>
>> Signed-off-by: Max Krummenacher <max.krummenacher@toradex.com>
>
> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>


Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
and merged into master-next, thanks!

>
> As a side note, this patch is a candidate for backports to currently
> maintained releases.


Oh right. I will take care of this.
Thanks!
Michael.

Patch

diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst
index 8d563714a..d484d08f8 100644
--- a/documentation/ref-manual/tasks.rst
+++ b/documentation/ref-manual/tasks.rst
@@ -326,21 +326,19 @@  file as a patch file::
        file://file;apply=yes \
        "
 
-Conversely, if you have a directory full of patch files and you want to
-exclude some so that the ``do_patch`` task does not apply them during
-the patch phase, you can use the "apply=no" parameter with the
+Conversely, if you have a file whose file type is ``.patch`` or ``.diff``
+and you want to exclude it so that the ``do_patch`` task does not apply
+it during the patch phase, you can use the "apply=no" parameter with the
 :term:`SRC_URI` statement::
 
    SRC_URI = " \
        git://path_to_repo/some_package \
-       file://path_to_lots_of_patch_files \
-       file://path_to_lots_of_patch_files/patch_file5;apply=no \
+       file://file1.patch \
+       file://file2.patch;apply=no \
        "
 
-In the
-previous example, assuming all the files in the directory holding the
-patch files end with either ``.patch`` or ``.diff``, every file would be
-applied as a patch by default except for the ``patch_file5`` patch.
+In the previous example ``file1.patch`` would be applied as a patch by default
+while ``file2.patch`` would not be applied.
 
 You can find out more about the patching process in the
 ":ref:`overview-manual/concepts:patching`" section in