Skip to content
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

cmd ref: add checkout --relink option, improve checkout desc. #864

Merged
merged 28 commits into from
Jan 7, 2020

Conversation

Suor
Copy link
Contributor

@Suor Suor commented Dec 14, 2019

No description provided.

Copy link
Member

@shcheklein shcheklein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a minor comment

I wonder if it would be valuable to add a sentence or two into the description that clarifies the semantics (that we don't relink by default and it's user's responsibility)

@Suor
Copy link
Contributor Author

Suor commented Dec 14, 2019

Higher on same page: "For any data files where the checksum doesn't match their DVC-file entry, the
data file is restored from the cache. The link strategy ..."

So --relink description builds on top of that: "recreates links ... even ones with unchanged checksums"

@Suor
Copy link
Contributor Author

Suor commented Dec 17, 2019

Reordered it everywhere to be from common to rare options: -d, -R, -f, --relink.

Related: iterative/dvc#2966

@shcheklein

This comment has been minimized.

static/docs/command-reference/checkout.md Outdated Show resolved Hide resolved
static/docs/command-reference/checkout.md Outdated Show resolved Hide resolved
@jorgeorpinel

This comment has been minimized.

@shcheklein

This comment has been minimized.

@jorgeorpinel

This comment has been minimized.

@jorgeorpinel
Copy link
Contributor

Guys, I took over this PR, sorry. I just had to basically rewrite much of the description to make things clearer. Thanks @Suor for explaining your points in #864 (review), marked resolved now. But please review the changes here and lmk or feel free to make further changes for us to make a final review. Thanks!

@Suor
Copy link
Contributor Author

Suor commented Dec 30, 2019

recreates (overwrites) links or copies from cache to workspace
for all outputs in the workspace, including the ones normally
checked out by this command, as well as existing ones with matching
checksums in current DVC-files.

"including the ones normally
checked out by this command" makes this really hard to get, "this command does what it normally does, including something ...". And you are making bold "existing", which is not the point, dvc checkout without relink also overwrites existing files.

@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-relink-ubdbmixgnby January 6, 2020 02:20 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-relink-ubdbmixgnby January 6, 2020 02:26 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-relink-ubdbmixgnby January 6, 2020 02:40 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-relink-ubdbmixgnby January 6, 2020 02:50 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-relink-ubdbmixgnby January 6, 2020 02:52 Inactive
@jorgeorpinel
Copy link
Contributor

Just pending to figure out #864 (review) ^

@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-relink-ubdbmixgnby January 6, 2020 05:32 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-relink-ubdbmixgnby January 6, 2020 05:37 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-relink-ubdbmixgnby January 6, 2020 22:42 Inactive
Copy link
Member

@shcheklein shcheklein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @jorgeorpinel @Suor !

@jorgeorpinel jorgeorpinel merged commit 7b2ea3a into iterative:master Jan 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants