Skip to content

Commit

Permalink
user-guide: large dataset: remove protected mention
Browse files Browse the repository at this point in the history
  • Loading branch information
efiop committed Mar 17, 2020
1 parent b2ad466 commit 14ecc26
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions public/static/docs/user-guide/large-dataset-optimization.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,9 @@ Symbolic links, and Reflinks in more recent systems. While reflinks bring all
the benefits and none of the worries, they're not commonly supported in most
platforms yet. Hard/soft links optimize **speed** and **space** in the file
system, but may break your workflow since updating hard/sym-linked files tracked
by DVC in the <abbr>workspace</abbr> causes <abbr>cache</abbr> corruption. These
2 link types thus require using cache **protected mode** (see the
`cache.protected` config option in `dvc config cache`), which is enabled
by-default and makes your files read-only. Finally, a 4th "linking" alternative
by DVC in the <abbr>workspace</abbr> causes <abbr>cache</abbr> corruption. To
protect against that, DVC makes hard/soft links read-only, forcing the user to
use `dvc unprotect` before modifying them. Finally, a 4th "linking" alternative
is to actually copy files from/to the cache, which is safe but inefficient –
especially for large files (several GBs or more).

Expand All @@ -54,12 +53,12 @@ especially for large files (several GBs or more).
File link type benefits summary:

| `cache.type` | speed | space | no protected mode |
| ------------ | ----- | ----- | ----------------- |
| `reflink` | x | x | x |
| `hardlink` | x | x | |
| `symlink` | x | x | |
| `copy` | | | x |
| `cache.type` | speed | space | no read-only links |
| ------------ | ----- | ----- | ------------------ |
| `reflink` | x | x | x |
| `hardlink` | x | x | |
| `symlink` | x | x | |
| `copy` | | | x |

Each file linking method is further detailed below, in function of their
efficiency:
Expand Down

0 comments on commit 14ecc26

Please sign in to comment.