[dunfell] ref-manual: fix patch documentation

Message ID 20220104104434.57039-1-michael.opdenacker@bootlin.com
State New
Headers show
Series [dunfell] ref-manual: fix patch documentation | expand

Commit Message

Michael Opdenacker Jan. 4, 2022, 10:44 a.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: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Max Krummenacher <max.krummenacher@toradex.com>
 documentation/ref-manual/ref-tasks.rst | 19 ++++++++-----------
 1 file changed, 8 insertions(+), 11 deletions(-)


diff --git a/documentation/ref-manual/ref-tasks.rst b/documentation/ref-manual/ref-tasks.rst
index 4ed15365f3..2f1959a010 100644
--- a/documentation/ref-manual/ref-tasks.rst
+++ b/documentation/ref-manual/ref-tasks.rst
@@ -331,22 +331,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
-``SRC_URI`` statement:
+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:`patching-dev-environment`" section in