Clarify `git lfs migrate` handling of local and remote references by chrisd8088 · Pull Request #5327 · git-lfs/git-lfs · GitHub
Skip to content

Clarify git lfs migrate handling of local and remote references - #5327

Merged
chrisd8088 merged 1 commit into
git-lfs:mainfrom
chrisd8088:revise-migrate-docs
Mar 31, 2023
Merged

chrisd8088 merged 1 commit into
git-lfs:mainfrom
chrisd8088:revise-migrate-docs

Conversation

@chrisd8088

Copy link
Copy Markdown
Member

When using the git lfs migrate command with its --everything option, all commits reachable from any refs, local or remote, are considered for migration; however, per PR #2559, only local refs are updated after the migration to avoid desynchronizing remote refs with the origin.

We therefore clarify this distinction in the command's manual page, as well as clarifying that the git push command's --all option refers only to local branches.

Resolves the documentation issue noted in #5316.

When using the "git lfs migrate" command with its --everything option,
all commits reachable from any refs, local or remote, are considered
for migration; however, per PR git-lfs#2559, only local refs are updated
after the migration to avoid desynchronizing remote refs with the
origin.

We therefore clarify this distinction in the command's manual page,
as well as clarifying that the "git push" command's --all option
refers only to local branches.
@chrisd8088
chrisd8088 requested a review from a team as a code owner March 31, 2023 08:17

@bk2204 bk2204 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for clarifying this. I think this is going to be help people understand the way things work much better.

@chrisd8088

chrisd8088 commented Mar 31, 2023 •

Copy link
Copy Markdown
Member Author

@chrisd8088
chrisd8088 merged commit 1c16945 into git-lfs:main Mar 31, 2023
@chrisd8088
chrisd8088 deleted the revise-migrate-docs branch March 31, 2023 21:45
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.

2 participants