1git-jump 2======== 3 4Git-jump is a script for helping you jump to "interesting" parts of your 5project in your editor. It works by outputting a set of interesting 6spots in the "quickfix" format, which editors like vim can use as a 7queue of places to visit (this feature is usually used to jump to errors 8produced by a compiler). For example, given a diff like this: 9 10------------------------------------ 11diff --git a/foo.c b/foo.c 12index a655540..5a59044 100644 13--- a/foo.c 14+++ b/foo.c 15@@ -1,3 +1,3 @@ 16 int main(void) { 17- printf("hello word!\n"); 18+ printf("hello world!\n"); 19 } 20----------------------------------- 21 22git-jump will feed this to the editor: 23 24----------------------------------- 25foo.c:2: printf("hello word!\n"); 26----------------------------------- 27 28Obviously this trivial case isn't that interesting; you could just open 29`foo.c` yourself. But when you have many changes scattered across a 30project, you can use the editor's support to "jump" from point to point. 31 32Git-jump can generate three types of interesting lists: 33 34 1. The beginning of any diff hunks. 35 36 2. The beginning of any merge conflict markers. 37 38 3. Any grep matches. 39 40 41Using git-jump 42-------------- 43 44To use it, just drop git-jump in your PATH, and then invoke it like 45this: 46 47-------------------------------------------------- 48# jump to changes not yet staged for commit 49git jump diff 50 51# jump to changes that are staged for commit; you can give 52# arbitrary diff options 53git jump diff --cached 54 55# jump to merge conflicts 56git jump merge 57 58# jump to all instances of foo_bar 59git jump grep foo_bar 60 61# same as above, but case-insensitive; you can give 62# arbitrary grep options 63git jump grep -i foo_bar 64-------------------------------------------------- 65 66 67Related Programs 68---------------- 69 70You can accomplish some of the same things with individual tools. For 71example, you can use `git mergetool` to start vimdiff on each unmerged 72file. `git jump merge` is for the vim-wielding luddite who just wants to 73jump straight to the conflict text with no fanfare. 74 75As of git v1.7.2, `git grep` knows the `--open-files-in-pager` option, 76which does something similar to `git jump grep`. However, it is limited 77to positioning the cursor to the correct line in only the first file, 78leaving you to locate subsequent hits in that file or other files using 79the editor or pager. By contrast, git-jump provides the editor with a 80complete list of files and line numbers for each match. 81 82 83Limitations 84----------- 85 86This scripts was written and tested with vim. Given that the quickfix 87format is the same as what gcc produces, I expect emacs users have a 88similar feature for iterating through the list, but I know nothing about 89how to activate it. 90 91The shell snippets to generate the quickfix lines will almost certainly 92choke on filenames with exotic characters (like newlines).