From 01971da9bd88c454403ba41b70c9e7f707d00bad Mon Sep 17 00:00:00 2001 From: Carl Dong Date: Mon, 15 Apr 2019 13:17:04 -0400 Subject: docs: Add productivity notes for "dummy rebases" --- doc/productivity.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'doc') 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. -- cgit v1.2.3