Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rephrase docs about apple_dot_clean tool #1065

Merged
merged 1 commit into from
Feb 7, 2019
Merged

Rephrase docs about apple_dot_clean tool #1065

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions reference/tools.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1531,9 +1531,11 @@ tools.apple_dot_clean()

def apple_dot_clean(folder)

Remove recursively all ``._`` files inside ``folder`` containing metadata information for Apple
operating systems, these files can appear when unzipping a file that has been created in Macos.
This tool will remove only files matching the pattern if there is file without the prefix too.
Remove recursively all ``._`` files inside ``folder``, these files are created by Apple OS when the
underlying filesystem cannot store metadata associated to files (they could appear when unzipping
a file that has been created in Macos). This tool will remove only the ``._`` files that are
accompanied with a file without that prefix (it will remove ``._file.txt`` only
if ``file.txt`` exists).

Parameters:
- **folder** (Required): root folder to start deleting ``._`` files.