Update config.md for #6419 (i.e. #6111) #2776
Conversation
Updated the config.md to document the new state.dir and index.dir options.
Syntax sugar, trying to satisfy the checks.
jorgeorpinel
added
the
⌛ status: wait-core-merge
| (By default, store SQLite-based remote indexes and state's | ||
| `links` and `md5s` caches in the repository itself to avoid any | ||
| possible state corruption in 'shared cache dir' scenario.) |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
There was a problem hiding this comment.
If this is about default behavior, I thin kit would be best to document that in https://dvc.org/doc/user-guide/project-structure/internal-files instead.
There was a problem hiding this comment.
BTW https://dvc.org/doc/user-guide/project-structure/internal-files doesn't mention "state file" so probably a terminology update is needed in this doc or in that other one? I.e. what internal files does state.dir affect exactly? (I guess .dvc/tmp/md5s and .dvc/tmp/links) Thanks
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
|
So iterative/dvc#6419 is still undecided though? We may want to wait until that's near final to finish this PR. Please remind me when to look again @meierale ! Thanks |
As suggested by @jorgeorpinel, I moved the default behavior description of `md5s` and `links`dirs to here. (from iterative#2776)
Hi @jorgeorpinel - I suggest to prepare the docs (this PR and #2826) so that they are ready when needed. But only merge when #6419 is being merged as well. |
@meierale Correct, waiting for the right moment with other stuff getting in and needing a release. |
Absolutely, thanks. I just wonder whether iterative/dvc#6419 can change in a way that requires reviewing the docs further so please lmk once that is approved to make a final review. I'll probably commit some suggestions for now though. |
| - `state.dir` - specify a custom location for the state file. This may be | ||
| necessary when using DVC on NFS or other mounted volumes. | ||
| ⚠️ Make sure no other project shares the same `state.dir` location. |
There was a problem hiding this comment.
Sorry, still confused. Which state file does this refer to? https://dvc.org/doc/user-guide/project-structure/internal-files doesn't use that term ("the state file") and the note introduced in #2826 doesn't clarify this either.
Does this change the location of .dvc/tmp/md5s or .dvc/tmp/links ? Or of both
There was a problem hiding this comment.
I tried to document it more clearly: state.dir affects the links and md5s directories, index.dir the index directory.
describe more in detail which folders are affected with the state.dir config entry.
|
Thanks for the PR, @meierale ! 🙏 @jorgeorpinel Let's hold on this PR for now, please, we need to reconsider some stuff on dvc side and we'll then come back to this ourselves. |
|
OK @efiop closing for now then... But iterative/dvc#6419 was merged so shouldn't we have this documented? And yes thanks again @meierale ! |
|
Ok, keeping and releasing this for now. So reopening. |
|
Merged this via #2891 but this is still showing open for some reason... 🤔 The changes are already in |
|
Resolved conflicts, now this PR has 0 changes 🤷 Merging! |
Need to do that though... |
|
p.s. thanks for taking over @efiop |
* Add note regarding default behavior of sqlite dirs As suggested by @jorgeorpinel, I moved the default behavior description of `md5s` and `links`dirs to here. (from #2776) * Update internal-files.md adjust documentation according to how it works in the PR ;-)9 * config.index: yarm format * config: corrections on index.dir and state.dir Co-authored-by: Jorge Orpinel <[email protected]>
Updated the config.md to document the new state.dir and index.dir options.
Per iterative/dvc#6419