samschott/maestral
1
1
Fork 0
mirror of https://github.com/samschott/maestral.git synced 2024-11-24 06:53:46 +03:00
Code Issues Projects Releases Wiki Activity

Updated mignore (markdown)

SamSchott 2021-02-14 22:59:51 +00:00
parent 6be222b712
commit b931affb3b
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
mignore.md

@ -1,12 +1,12 @@
When excluding files or folders with selective sync (`maestral exclude` in the CLI), they will be removed from the local folder and kept in the cloud only. However, there also is a valid use case for excluding files from syncing which exist only in the local Dropbox directory and not in the cloud. Those could be for instance build artefacts or system files which Maestral does not already exclude by default.
As of version 0.6.2, Maestral supports excluding local files from syncing by using a ".mignore" file to specify patterns of file names to be ignored. The ".mignore" file must be saved in the top-level Dropbox folder. It uses the same syntax as [gitignore files](https://git-scm.com/docs/gitignore) and tries to adhere to the same paradigms:
As of version 0.6.2, Maestral supports excluding local files from syncing by using a ".mignore" file to specify patterns of file names to be ignored. The ".mignore" file must be saved in the top-level Dropbox folder. It uses the same syntax as [gitignore files](https://git-scm.com/docs/gitignore) but behaves slightly differently:
- If you add a pattern to mignore, it will apply to new files and folder only. Items which are synced will continue syncing.
- If you remove a pattern from mignore, you will need to pause and resume syncing to index any newly included items. This may change in the future.
- If you add a new mignore pattern, **any matching files or folder will be removed from the remote Dropbox** and will only exist locally.
- If you remove a pattern from mignore, you will need to pause and resume syncing to index and upload any newly included items.
- If a local file or folder is moved to an ignored path, it will be deleted from Dropbox.
- If an item is moved from an ignored path to an included one, it will be uploaded to Dropbox.
- When a file is excluded by mignore and a file with the same name is created in the cloud, the remote file will be downloaded and included in syncing. If the content differs from the local file content, a conflicting copy is created and both the copy and the original file will be included in syncing.
- When a file is excluded by mignore and a file with the same name is created in the cloud, the remote file may be downloaded and included in syncing temporally. However, the next time syncing is paused and resumed, it will removed from the cloud.
**Warning:** Currently, pattern matching is case sensitive. A pattern `Foo.txt` in mignore will match the file name "Foo.txt" but not "foo.txt". This may change in the future since Dropbox itself is case-insensitive. See the note about how Maestral handles [case-sensitive file systems](https://github.com/SamSchott/maestral-dropbox/wiki/Case-sensitive-file-systems).