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

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

choznerol
Copy link

@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
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.

Rebase instruction include the deprecated --preserve-merges option
1 participant