Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

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

Rename commit cmd --no-commit options to cache and --no-cache #5000

Closed
jorgeorpinel opened this issue Dec 1, 2020 · 1 comment
Closed

Rename commit cmd --no-commit options to cache and --no-cache #5000

jorgeorpinel opened this issue Dec 1, 2020 · 1 comment
Labels
enhancement Enhances DVC p3-nice-to-have It should be done this or next sprint ui user interface / interaction

Comments

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Dec 1, 2020

After reviewing and simplifying the dvc commit cmd ref (in iterative/dvc.org/pull/1978) I realized it can be confusing to call this "committing" since we're mainly talking about caching (or not) data. Yes, it can also change hash values in DVC files but that's kind of an edge case given the main use for this: Data/code dev process where add/repro/run --no-commit are used until ready, and finished by a commit — the hash values are already saves in the DVC files by add/repro/run.

And we also have run --metrics/plots-no-cache, so no-cache is more consistent with those.

Finally, changing dvc commit to dvc cache and --no-commit to --no-cache would also help avoid confusions related to the Git analogies we use. Specifically, it will help clarify that DVC does not perform the actual versioning, but that Git does, through commits. Currently we need to have the following clarification near the top of the ref:

Note that this does not register project versions. That can be done with git commit.


Maybe a change for 2.x? And it doesn't have to break backward compatibility if the old names are kept as aliases.

@jorgeorpinel jorgeorpinel added enhancement Enhances DVC discussion requires active participation to reach a conclusion labels Dec 1, 2020
@jorgeorpinel jorgeorpinel changed the title cmd: rename commit cmd and --no-commit option to cache and --no-cache cmd: rename commit cmd and --no-commit option to cache and --no-cache Dec 1, 2020
@jorgeorpinel jorgeorpinel changed the title cmd: rename commit cmd and --no-commit option to cache and --no-cache cmd: rename commit cmd and --no-commit options to cache and --no-cache Dec 1, 2020
@jorgeorpinel jorgeorpinel changed the title cmd: rename commit cmd and --no-commit options to cache and --no-cache Rename commit cmd --no-commit options to cache and --no-cache Dec 1, 2020
@skshetry
Copy link
Member

skshetry commented Dec 1, 2020

Magic number 🎉
Screenshot from 2020-12-01 11-11-50

@efiop efiop added the p3-nice-to-have It should be done this or next sprint label Dec 1, 2020
@jorgeorpinel jorgeorpinel added ui user interface / interaction and removed discussion requires active participation to reach a conclusion labels Dec 1, 2020
@efiop efiop closed this as completed May 3, 2021
@iterative iterative locked and limited conversation to collaborators May 3, 2021

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Labels
enhancement Enhances DVC p3-nice-to-have It should be done this or next sprint ui user interface / interaction
Projects
None yet
Development

No branches or pull requests

3 participants