[Filesystem] Add docs for Filesystem::mirror() options#17394
Open
maxbeckers wants to merge 1 commit intosymfony:6.4from
Open
[Filesystem] Add docs for Filesystem::mirror() options#17394maxbeckers wants to merge 1 commit intosymfony:6.4from
Filesystem::mirror() options#17394maxbeckers wants to merge 1 commit intosymfony:6.4from
Conversation
1 task
OskarStark
reviewed
Oct 24, 2022
OskarStark
changed the title
Filesystem::mirror() options
Contributor
|
Please target |
maxbeckers
force-pushed
the
patch-symfony-25798
branch
from
a726669 to
51d9c17
Compare
OskarStark
reviewed
Jun 6, 2023
| The following options can be passed: | ||
|
|
||
| * ``override`` (default: ``false``): If true, target files newer than origin files are overwritten (see :method:`Symfony\\Component\\Filesystem\\Filesystem::copy`) | ||
| * ``copy_on_windows`` (default: ``false``): Whether to copy files instead of links on Windows. Since symfony/filesystem 6.4 this option is deprecated, use follow_symlinks instead. |
Contributor
There was a problem hiding this comment.
I would remove the deprecated sentence here and ...
OskarStark
reviewed
Jun 6, 2023
| * ``copy_on_windows`` (default: ``false``): Whether to copy files instead of links on Windows. Since symfony/filesystem 6.4 this option is deprecated, use follow_symlinks instead. | ||
| * ``follow_symlinks`` (default: ``false``): Whether to copy files instead of links, where using symlinks in not working: windows, different drive, docker context not supporting symlinks. | ||
| * ``delete`` (default: ``false``): Whether to delete files that are not in the source directory. | ||
|
|
Contributor
There was a problem hiding this comment.
... add a deprecated:: directive here
alamirault
reviewed
Oct 17, 2023
|
|
||
| * ``override`` (default: ``false``): If true, target files newer than origin files are overwritten (see :method:`Symfony\\Component\\Filesystem\\Filesystem::copy`) | ||
| * ``copy_on_windows`` (default: ``false``): Whether to copy files instead of links on Windows. Since symfony/filesystem 6.4 this option is deprecated, use follow_symlinks instead. | ||
| * ``follow_symlinks`` (default: ``false``): Whether to copy files instead of links, where using symlinks in not working: windows, different drive, docker context not supporting symlinks. |
Contributor
There was a problem hiding this comment.
Windows is capitalized in other rst files
Suggested change
| * ``follow_symlinks`` (default: ``false``): Whether to copy files instead of links, where using symlinks in not working: windows, different drive, docker context not supporting symlinks. | |
| * ``follow_symlinks`` (default: ``false``): Whether to copy files instead of links, where using symlinks in not working: Windows, different drive, docker context not supporting symlinks. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds the options for
Filesystem::mirror()including the renamed optioncopy_on_windowstofollow_symlinkswith deprecation the old option. The related PR in Symfony project is symfony/symfony#47969.