Conversation

maxbeckers

This PR adds the options for Filesystem::mirror() including the renamed option copy_on_windows to follow_symlinks with deprecation the old option. The related PR in Symfony project is symfony/symfony#47969.

@OskarStarkOskarStark changed the title [Filesystem] Add docs for Filesystem::mirror() options [Filesystem] Add docs for Filesystem::mirror() options Oct 24, 2022
@OskarStark

Please target 6.4 branch, thanks

@maxbeckersmaxbeckers changed the base branch from 6.2 to 6.4 June 5, 2023 08:34
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would remove the deprecated sentence here and ...

* ``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.
* ``delete`` (default: ``false``): Whether to delete files that are not in the source directory.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... add a deprecated:: directive here


* ``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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Sign up for free to join this conversation on . Already have an account? Sign in to comment
Filesystem Status: Needs Review Waiting Code MergeDocs for features pending to be merged
None yet

Successfully merging this pull request may close these issues.