OLD | NEW |
1 git-hyper-blame(1) | 1 git-hyper-blame(1) |
2 ================== | 2 ================== |
3 | 3 |
4 NAME | 4 NAME |
5 ---- | 5 ---- |
6 git-hyper-blame - | 6 git-hyper-blame - |
7 include::_git-hyper-blame_desc.helper.txt[] | 7 include::_git-hyper-blame_desc.helper.txt[] |
8 | 8 |
9 SYNOPSIS | 9 SYNOPSIS |
10 -------- | 10 -------- |
(...skipping 33 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
44 aren't interested in the uppercasing of the file. You want to know who | 44 aren't interested in the uppercasing of the file. You want to know who |
45 wrote/modified those lines in the first place. Just tell `hyper-blame` to ignore | 45 wrote/modified those lines in the first place. Just tell `hyper-blame` to ignore |
46 that commit: | 46 that commit: |
47 | 47 |
48 demo:2[] | 48 demo:2[] |
49 | 49 |
50 `hyper-blame` places a `*` next to any line where it has skipped over an ignored | 50 `hyper-blame` places a `*` next to any line where it has skipped over an ignored |
51 commit, so you know that the line in question has been changed (by an ignored | 51 commit, so you know that the line in question has been changed (by an ignored |
52 commit) since the given person wrote it. | 52 commit) since the given person wrote it. |
53 | 53 |
| 54 CAVEATS |
| 55 ------- |
| 56 |
| 57 When a line skips over an ignored commit, a guess is made as to which commit |
| 58 previously modified that line, but it is not always clear where the line came |
| 59 from. If the ignored commit makes lots of changes in close proximity, in |
| 60 particular adding/removing/reordering lines, then the wrong authors may be |
| 61 blamed for nearby edits. |
| 62 |
| 63 For this reason, `hyper-blame` works best when the ignored commits are be |
| 64 limited to minor changes such as formatting and renaming, not refactoring or |
| 65 other more invasive changes. |
| 66 |
54 BUGS | 67 BUGS |
55 ---- | 68 ---- |
56 | 69 |
57 - When a commit is ignored, hyper-blame currently just blames the same line in | |
58 the previous version of the file. This can be wildly inaccurate if the ignored | |
59 commit adds or removes lines, resulting in a completely wrong commit being | |
60 blamed. | |
61 - There is currently no way to pass the ignore list as a file. | 70 - There is currently no way to pass the ignore list as a file. |
62 - It should be possible for a git repository to configure an automatic list of | 71 - It should be possible for a git repository to configure an automatic list of |
63 commits to ignore (like `.gitignore`), so that project owners can maintain a | 72 commits to ignore (like `.gitignore`), so that project owners can maintain a |
64 list of "big change" commits that are ignored by hyper-blame by default. | 73 list of "big change" commits that are ignored by hyper-blame by default. |
65 | 74 |
66 SEE ALSO | 75 SEE ALSO |
67 -------- | 76 -------- |
68 linkgit:git-blame[1] | 77 linkgit:git-blame[1] |
69 | 78 |
70 include::_footer.txt[] | 79 include::_footer.txt[] |
71 | 80 |
72 // vim: ft=asciidoc: | 81 // vim: ft=asciidoc: |
OLD | NEW |