-
Notifications
You must be signed in to change notification settings - Fork 394
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.
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
docs: update files/dirs for 1.0 release #1215
Changes from 2 commits
b5a9d29
97414e6
afa5794
9e8a359
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -24,24 +24,28 @@ operation: | |
> repository, only [DVC-files](/doc/user-guide/dvc-file-format) that are | ||
> needed to download or reproduce them. | ||
|
||
- `.dvc/state`: This file is used for optimization. It is a SQLite database, | ||
- `.dvc/tmp`: Directory for miscellaneous temporary files | ||
|
||
- `.dvc/tmp/index`: Directory for remote index files that are used for | ||
optimizing `dvc push/pull/fetch/status -c` operations. | ||
efiop marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- `.dvc/tmp/state`: This file is used for optimization. It is a SQLite database, | ||
that contains hash values for files tracked in a DVC project, with respective | ||
timestamps and inodes to avoid unnecessary file hash computations. It also | ||
contains a list of links (from cache to <abbr>workspace</abbr>) created by DVC | ||
and is used to cleanup your workspace when calling `dvc checkout`. | ||
|
||
- `.dvc/state-journal`: Temporary file for SQLite operations | ||
- `.dvc/tmp/state-journal`: Temporary file for SQLite operations | ||
|
||
- `.dvc/state-wal`: Another SQLite temporary file | ||
- `.dvc/tmp/state-wal`: Another SQLite temporary file | ||
|
||
- `.dvc/updater`: This file is used store the latest available version of DVC. | ||
It's used to remind the user to upgrade when the installed version is behind. | ||
- `.dvc/tmp/updater`: This file is used store the latest available version of | ||
DVC. It's used to remind the user to upgrade when the installed version is | ||
behind. | ||
Comment on lines
+42
to
+44
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why do we need to document for There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @skshetry Sure, we could make it a black box, but people will still get nosy and will ask questions. So easier to document it once and for all π |
||
|
||
- `.dvc/updater.lock`: Lock file for `.dvc/updater` | ||
- `.dvc/tmp/updater.lock`: Lock file for `.dvc/tmp/updater` | ||
|
||
- `.dvc/lock`: Lock file for the entire DVC project | ||
|
||
- `.dvc/tmp`: Directory for miscellaneous temporary files | ||
- `.dvc/tmp/lock`: Lock file for the entire DVC project | ||
|
||
- `.dvc/tmp/rwlock`: JSON file that contains read and write locks for specific | ||
dependencies and outputs, to allow safely running multiple DVC commands in | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it creates a link automatically to the commands, better split this into more verbose but clean:
dvc pull -c
,dvc push -c
etc