aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMarcoFalke <falke.marco@gmail.com>2019-05-16 13:44:47 -0400
committerMarcoFalke <falke.marco@gmail.com>2019-05-16 13:45:12 -0400
commitfd7d97decbf4becccf4ccf33d467eee6b21fa76e (patch)
tree070c98b2951ed75c62fcc2778b3d3c82254f955e /doc
parent376638afcf945ec43089625d115286594ce0ab16 (diff)
parent01971da9bd88c454403ba41b70c9e7f707d00bad (diff)
downloadbitcoin-fd7d97decbf4becccf4ccf33d467eee6b21fa76e.tar.xz
Merge #15820: docs: Add productivity notes for dummy rebases
01971da9bd docs: Add productivity notes for "dummy rebases" (Carl Dong) Pull request description: When rebasing, we often want to do a "dummy rebase" whereby we are not rebasing over an updated master. This is because rebases can be confusing enough already, and we don't want to resolve upstream conflicts together with our local rebase conflicts due to fixup commits, commit rearrangements, and such. This productivity section details how to do such "dummy rebase"s. ACKs for commit 01971d: Tree-SHA512: 241a451cec01dc9a01a2286bdee1441cac6d28007f5b173345744d2abf436da916c3f2553ff0d1c5b3687055107b37872dda9529288645e4bae7b3cb46923b7e
Diffstat (limited to 'doc')
-rw-r--r--doc/productivity.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/productivity.md b/doc/productivity.md
index a93228ebdb..b25ddc94e5 100644
--- a/doc/productivity.md
+++ b/doc/productivity.md
@@ -10,6 +10,7 @@ Table of Contents
* [Make use of your threads with `make -j`](#make-use-of-your-threads-with-make--j)
* [Only build what you need](#only-build-what-you-need)
* [Multiple working directories with `git worktrees`](#multiple-working-directories-with-git-worktrees)
+ * [Interactive "dummy rebases" for fixups and execs with `git merge-base`](#interactive-dummy-rebases-for-fixups-and-execs-with-git-merge-base)
* [Writing code](#writing-code)
* [Format C/C++/Protobuf diffs with `clang-format-diff.py`](#format-ccprotobuf-diffs-with-clang-format-diffpy)
* [Format Python diffs with `yapf-diff.py`](#format-python-diffs-with-yapf-diffpy)
@@ -93,6 +94,21 @@ To simply check out a commit-ish under a new working directory without disruptin
git worktree add --checkout ../where-my-checkout-commit-ish-will-live my-checkout-commit-ish
```
+### Interactive "dummy rebases" for fixups and execs with `git merge-base`
+
+When rebasing, we often want to do a "dummy rebase," whereby we are not rebasing over an updated master but rather over the last common commit with master. This might be useful for rearranging commits, `rebase --autosquash`ing, or `rebase --exec`ing without introducing conflicts that arise from an updated master. In these situations, we can use `git merge-base` to identify the last common commit with master, and rebase off of that.
+
+To squash in `git commit --fixup` commits without rebasing over an updated master, we can do the following:
+
+```sh
+git rebase -i --autosquash "$(git merge-base master HEAD)"
+```
+
+To execute `make check` on every commit since last diverged from master, but without rebasing over an updated master, we can do the following:
+```sh
+git rebase -i --exec "make check" "$(git merge-base master HEAD)"
+```
+
-----
This synergizes well with [`ccache`](#cache-compilations-with-ccache) as objects resulting from unchanged code will most likely hit the cache and won't need to be recompiled.