help/docs bug: blame view keybindings are hard to discover
ilyagr opened this issue · comments
I wish they were documented in the in-program help better. There could be a "blame bindings" section. I realize that all the bindings are mentioned in the help already, but their descriptions make it very difficult to understand how they actually work in blame view. Blame is very useful occasionally, but I find it difficult to remember the bindings whenever I use it.
My understanding is that, in blame view:
Enter
opens the blamed commit for the current line in a separate paneb
opens the current file at the blamed commit when already in blame view<
goes back to the previous view, e.g. undoesb
(as elsewhere in tig, but I only use it when blaming),
seems like it could be useful according to the help,but is not actually useful in blame view AFAICT.UPDATE: It is useful, but I'm still unsure what exactly it does. See the next comment.UPDATE 2: It shows the last commit before the blamed commit for the current line that modified the selected line.
Thanks for making tig
, it's very useful! I was thinking of making a PR for this, but I couldn't immediately figure out how the help is generated.
I realized that even here, I misunderstood something. It seems that the ,
command is important in blame. I'm guessing it's meant to go to either (the last commit before the current one that modified the current file) or (the last commit before the blamed commit for the current line that modified the selected line).
Update: It seems to be the latter. I wish there was a command for the former as well. E.g., ,
could do the former and B
could do the latter. When I read the ,
in the help described as "Move to parent", I expected the former behavior.
Another confusing thing about the ,
command is that it sometimes shows the message "The selected commit has not parents". I wish this message was clearer: is the selected commit the one on the current line or the one currently being viewed? It could say something like "Commit abcdef1 has no ancestors that modify this line", that would already make things clearer.
BTW, I'd be happy to try implementing this myself, but it'd help if you gave me some pointers.
, shows the last commit before the blamed commit for the current line that modified the selected line.
Right. I never really used, it seems nice. Sadly it can't know where a line moved to, so the initial position can be confusing.
I usually alternate between blame and diff view for recursive blaming.
Sadly it can't know where a line moved to, so the initial position can be confusing.
That's a good point. If the "going to an ancestor of the currently displayed commit" operation existed, it'd be equivalent to b
followed by that operation, so it overall seems less important.
I think having b
, B
(optional, would do what ,
currently does), ,
(for going to a parent of the currently displayed commit, as seems to match its description in the help, and is nice to track the evolution of a file), and <
would be a good interface, especially it's documented. The (new) blame section of the help could document b
and B
, and either also document ,
and <
(repeating an earlier section, possibly with variations), or just mention "See also ,
and <
commands which are particularly useful in blame view".
We could also keep ,
as is, and add B
that does the other thing, but I think that's be more confusing for all people except those who are very used to the current behavior of ,
.
For diff view, I get a bit confused by the multi-view controls, so I seem to tend to avoid it. I just realized that <Tab>
seems to switch the meaning of j
/k
and but not the meaning of Up/Down (Update:) or J
/K
,J
/K
. But that's a separate issue that might be harder to address.
Update:
I usually alternate between blame and diff view for recursive blaming.
I'm realizing I'm not sure how to do this,