Re: [PATCH v4 1/5] doc: git-rebase: start with an example
From: Karthik Nayak <hidden>
Date: 2025-08-11 09:13:08
"Julia Evans via GitGitGadget" [off-list ref] writes:
From: Julia Evans <redacted> Start with an example that mirrors the example in the `git-merge` man page, to make it easier for folks to understand the difference between a rebase and a merge.
Happy to see these changes.
quoted hunk ↗ jump to hunk
Signed-off-by: Julia Evans <redacted> --- Documentation/git-rebase.adoc | 49 ++++++++++++++++------------------- 1 file changed, 23 insertions(+), 26 deletions(-)diff --git a/Documentation/git-rebase.adoc b/Documentation/git-rebase.adoc index 956d3048f5a6..449f01fba560 100644 --- a/Documentation/git-rebase.adoc +++ b/Documentation/git-rebase.adoc@@ -16,6 +16,29 @@ SYNOPSIS DESCRIPTION ----------- +Transplant a series of commits onto a different starting point. + +For example, imagine that you have been working on the `topic` branch in this +history, and you want to "catch up" to the work done on the `master` branch. + +------------ + A---B---C topic + / + D---E---F---G master +------------ + +You want to transplant the commits you made on `topic` since it diverged from +`master` (i.e. A, B, and C), on top of the current `master`. You can do this +by running `git rebase master` while the `topic` branch is checked out. If you +want to rebase `topic` while on another branch, `git rebase master topic` is a +shortcut for `git checkout topic && git rebase master`. +
Nit: now that `git-switch(1)` is no longer experimental, we should start recommending it over `git-checkout(1)` as necessary. So perhaps, we could s/checkout/switch here? [snip]
Attachments
- signature.asc [application/pgp-signature] 690 bytes