Skip to content
This repository was archived by the owner on Jan 15, 2026. It is now read-only.

docs: Replace deprecated --preserve-merges with --rebase-merges#218

Open
choznerol wants to merge 1 commit intorust-lang:masterfrom
choznerol:217-avoid-suggesting-git-rebase---preserve-merges
Open

docs: Replace deprecated --preserve-merges with --rebase-merges#218
choznerol wants to merge 1 commit intorust-lang:masterfrom
choznerol:217-avoid-suggesting-git-rebase---preserve-merges

Conversation

@choznerol
Copy link
Copy Markdown

@choznerol choznerol commented Jun 16, 2024

Fixes #217

I'm not 100% sure about recommending --rebase-merges, or if the default behavior (dropping merge commits) would be just fine.

We may want git rebase upstream/master --rebase-merges because there is probably a reason we recommended --preserve-merges in the first place. According to the documentation, --rebase-merges is most similar to --preserve-merges:

The `--rebase-merges` mode is similar in spirit to the deprecated `--preserve-merges` but works with interactive rebases, where commits can be reordered, inserted, and dropped at will.

On the other hand, if we're unclear why we recommended --preserve-merges in the first place (considering #217 might have been an issue since 2021), maybe the simpler git rebase upstream/master is just better.

Disclaimer: I never knew about --preserve-merges or --rebase-merges before #217.

@choznerol choznerol force-pushed the 217-avoid-suggesting-git-rebase---preserve-merges branch from 527c8a5 to d938f23 Compare June 16, 2024 03:04
@reneleonhardt
Copy link
Copy Markdown

For what it's worth, the default branch name has been changed from master to main 5 years ago... 😄

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rebase instruction include the deprecated --preserve-merges option

2 participants