diff --git a/content/docs/user-guide/project-structure/configuration.md b/content/docs/user-guide/project-structure/configuration.md index 38f17792a5..7eade7a8b5 100644 --- a/content/docs/user-guide/project-structure/configuration.md +++ b/content/docs/user-guide/project-structure/configuration.md @@ -111,6 +111,10 @@ within: DVC files created or modified by DVC commands. The files will not be committed. Accepts values `true` and `false` (default). +- `core.site_cache_dir` - specify a custom location for misc temporary files. + Read more + [here](/doc/user-guide/project-structure/internal-files#site-cache-dir). +
@@ -360,6 +364,13 @@ Composition]. ## state + + +This section is obsolete since DVC 2.48.0. Modifying these config options will +have no effect. + + + - `state.row_limit` - maximum number of entries in state databases. This affects the physical size of the state files, as well as the performance of certain DVC operations. The default is 10,000,000 rows. The bigger the limit, the @@ -380,6 +391,13 @@ Composition]. ## index + + +This section is obsolete since DVC 2.48.0. Modifying these config options will +have no effect. + + + - `index.dir` - specify a custom location for the directory where remote index files will be stored, by default in `.dvc/tmp/index`. This may be necessary when using DVC on NFS or other mounted volumes. diff --git a/content/docs/user-guide/project-structure/internal-files.md b/content/docs/user-guide/project-structure/internal-files.md index 05d01a8314..e74b8d9547 100644 --- a/content/docs/user-guide/project-structure/internal-files.md +++ b/content/docs/user-guide/project-structure/internal-files.md @@ -51,36 +51,6 @@ Not to be confused with `.dvc` files. - `.dvc/tmp`: Directory for miscellaneous temporary files -- `.dvc/tmp/index`: Directory for remote index files that are used for - optimizing `dvc push`, `dvc pull`, `dvc fetch` and `dvc status -c` operations. - - - - This location may be overridden with `dvc config index.dir`. - - - -- `.dvc/tmp/md5s`: This directory is used for optimization. It contains a SQLite - state database that stores hash values for files tracked in a DVC project. It - also saves the corresponding timestamps and inodes to avoid unnecessary file - hash computations. - - - - This parent location may be overridden with `dvc config state.dir`. - - - -- `.dvc/tmp/links`: This directory is used to clean up your workspace when - calling `dvc checkout`. It contains a SQLite state database that stores a list - of file links created by DVC (from cache to workspace). - - - - This parent location may be overridden with `dvc config state.dir`. - - - - `.dvc/tmp/updater`: This file is used to store the latest available version of DVC. It's used to remind the user to upgrade when the installed version is behind. @@ -214,3 +184,37 @@ unexpected behavior]). [avoiding unexpected behavior]: /doc/user-guide/project-structure/dvcyaml-files#avoiding-unexpected-behavior + +## Site cache dir + +Directory used for storing temporary files. + +Default location: + +| macOS | Linux (typical\*) | Windows | +| --------------------- | ----------------- | ------------------------------ | +| `/Library/Caches/dvc` | `/var/tmp/dvc` | `C:\ProgramData\iterative\dvc` | + + + +This location may be overridden with `dvc config core.site_cache_dir`. + + + + + +Not to be confused with DVC cache. + + + +- `index`: Directory for remote index files that are used for optimizing + `dvc push`, `dvc pull`, `dvc fetch` and `dvc status -c` operations. + +- `hashes`: This directory is used for optimization. It contains a SQLite state + database that stores hash values for files tracked in a DVC project. It also + saves the corresponding timestamps and inodes to avoid unnecessary file hash + computations. + +- `links`: This directory is used to clean up your workspace when calling + `dvc checkout`. It contains a SQLite state database that stores a list of file + links created by DVC (from cache to workspace).