summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorStephen Jung <tummychow511@gmail.com>2018-12-11 21:00:56 -0800
committerGitHub <noreply@github.com>2018-12-11 21:00:56 -0800
commite37669e55ab39b8445e9d5eee2ee21bab1754db3 (patch)
treead3ed0718e7a5f578816d440ad4a31560ec3ba6d /README.md
parent922b0a3dd701bc481716e8c6df0b218bd6623e59 (diff)
parent99176de4943649be3dbdb103befd745664b1ef4b (diff)
Merge pull request #5 from nightscape/patch-2
Use commit message instead of the SHA in fixup
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.md b/README.md
index dc883d3..9d5fcc3 100644
--- a/README.md
+++ b/README.md
@@ -29,7 +29,7 @@ Note that `git absorb` does _not_ use the system libgit2. This means you do not
## Usage
1. `git add` any changes that you want to absorb. By design, `git absorb` will only consider content in the git index.
-2. `git absorb`. This will create a sequence of commits on `HEAD`. Each commit will have a `fixup!` message indicating the SHA of the commit it should be squashed into.
+2. `git absorb`. This will create a sequence of commits on `HEAD`. Each commit will have a `fixup!` message indicating the message (if unique) or SHA of the commit it should be squashed into.
3. If you are satisfied with the output, `git rebase -i --autosquash` to squash the `fixup!` commits into their predecessors. You can set the [`GIT_SEQUENCE_EDITOR`](https://stackoverflow.com/a/29094904) environment variable if you don't need to edit the rebase TODO file.
4. If you are not satisfied (or if something bad happened), `git reset --soft` to the pre-absorption commit to recover your old state. (You can find the commit in question with `git reflog`.) And if you think `git absorb` is at fault, please [file an issue](https://github.com/tummychow/git-absorb/issues/new).