Skip to content

Commit

Permalink
Docs for #10408 (conan-io#2382)
Browse files Browse the repository at this point in the history
  • Loading branch information
lasote authored Feb 1, 2022
1 parent f089c9f commit be68626
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions reference/conanfile/tools/files.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@ conan.tools.files.patch()

.. code-block:: python
def patch(conanfile, base_path=None, patch_file=None, patch_string=None,
strip=0, fuzz=False, **kwargs):
def patch(conanfile, base_path=None, patch_file=None, patch_string=None, strip=0, fuzz=False, **kwargs):
Applies a diff from file (*patch_file*) or string (*patch_string*) in the ``conanfile.source_folder`` directory.
The folder containing the sources can be customized with the ``self.folders`` attribute in the :ref:`layout(self)
method<layout_folders_reference>`.

Parameters:

- **patch_file**: Patch file that should be applied.
- **base_path**: Relative path from **conanfile.source_folder**.
- **patch_file**: Patch file that should be applied. The path is relative to the **conanfile.source_folder** unless
an absolute path is provided.
- **base_path**: The path is a relative path to **conanfile.source_folder** unless an absolute path is provided.
- **patch_string**: Patch string that should be applied.
- **strip**: Number of folders to be stripped from the path.
- **output**: Stream object.
Expand Down

0 comments on commit be68626

Please sign in to comment.