[PATCH] ref-manual: fix patch documentation

[PATCH] ref-manual: fix patch documentation

[Max Krummenacher]

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(-)

diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst
index 8d563714a..76f55e1ff 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 ``*.patch`` and ``*.diff`` and you want
+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
-- 
2.20.1

Re: [docs] [PATCH] ref-manual: fix patch documentation

[Quentin Schulz]

Hi Max,

On 12/28/21 13:46, 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>
> ---
>   documentation/ref-manual/tasks.rst | 16 +++++++---------
>   1 file changed, 7 insertions(+), 9 deletions(-)
> 
> diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst
> index 8d563714a..76f55e1ff 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 ``*.patch`` and ``*.diff`` and you want

"""
Conversely, if you have a file whose file type is ``.patch`` or 
``.diff`` and you want to exclude it so
"""

to match the wording used for the apply=yes example just above the git 
context above.

> +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.
>   

s/file1.patch/``file1.patch``/
s/file2.patch/``file2.patch``/

Cheers,
Quentin