Skip to content

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

Closed

Description

@jorgeorpinel

After reviewing and simplifying the dvc commit cmd ref (in treeverse/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.

Activity

  1. 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[/+] on Dec 1, 2020
  2. 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[/+] on Dec 1, 2020
  3. 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[/+] on Dec 1, 2020
  4. skshetry commented on Dec 1, 2020

    @skshetry
    Collaborator

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

  5. added
    uiuser interface / interaction
    and removed
    discussionrequires active participation to reach a conclusion
    on Dec 1, 2020
  6. locked and limited conversation to collaborators on May 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementEnhances DVCp3-nice-to-haveIt should be done this or next sprintuiuser interface / interaction

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions