Skip to content

Branching - #2890

Open
philocalyst wants to merge 84 commits into
gitui-org:masterfrom
philocalyst:branching
Open

philocalyst wants to merge 84 commits into
gitui-org:masterfrom
philocalyst:branching

Conversation

@philocalyst

@philocalyst philocalyst commented Mar 24, 2026 •

Copy link
Copy Markdown

This Pull Request fixes/closes #81.

It changes the following:

  • Implements a complete view of commit lineage
  • Borrows the logic/implementation from the well-tested guitar
  • Conforms to the streaming model that was used in the previous version of the displays, meaning its performance impact is negligible.
  • Has a new keybind to hide the graph, as a toggle.
  • Expands and contracts dynamically based on what is currently on-screen
  • Makes good use of space by compressing whitespace when possible (Through re-using lanes)
  • Remains consistent against the rest of the UI.
Screenshot 2026-03-23 at 22 14 25 Screenshot 2026-03-23 at 22 15 36

I followed the checklist:

  • I added unittests
  • I ran make check without errors
  • I tested the overall application
  • I added an appropriate item to the changelog

@philocalyst

philocalyst commented Mar 24, 2026 •

Copy link
Copy Markdown
Author

@extrawurst Would love your feedback on this :) Quite large.

OH! And I just noticed that I removed the missing docs lint, I'll add that back if we agree on this general direction.

@gogongxt

Copy link
Copy Markdown

LGTM

@extrawurst
extrawurst requested a review from cruessler March 29, 2026 17:29
Comment thread CHANGELOG.md Outdated
* fix extremely slow status loading in large repositories by replacing time-based cache invalidation with generation counter [[@DannyStoll1](https://github.com/DannyStoll1)] ([#2823](https://github.com/gitui-org/gitui/issues/2823))
* fix panic when renaming or updating remote URL with no remotes configured [[@xvchris](https://github.com/xvchris)] ([#2868](https://github.com/gitui-org/gitui/issues/2868))
### Added
* Now with a graph view!

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please match the ususal format

@extrawurst

Copy link
Copy Markdown
Collaborator

I think we need to improve the visualization still, this is the same point in time of the history in three different tools: gitui, tig and fork:

Screenshot 2026-03-29 at 19 50 36 Screenshot 2026-03-29 at 19 50 27 Screenshot 2026-03-29 at 19 51 51

@philocalyst

philocalyst commented Mar 29, 2026 via email

Copy link
Copy Markdown
Author

@VojtaStanek

Copy link
Copy Markdown

I am looking forward to this change!

By a quick look the source it seems like it works only with merge commits with 2 parents, but commit can have an arbitrary number of parents (see e.g. here).

@philocalyst

Copy link
Copy Markdown
Author

@VojtaStanek Yes! Octopus merges! That's not covered here.

I couldn't find an implementation that handles them in a way that maps well to streaming. They don't crash anything, and happen incredibly rarely. If someone is able to extend what I have here, they're welcome to; but it shouldn't block merging.

@cruessler

Copy link
Copy Markdown
Collaborator

Thanks a lot for getting this started, that’s much appreciated! I just started reviewing the changes, but then I had a few more general questions.

In its current form, I find it hard to see merge commits and how they connect to their respective parents. The image below shows a comparison between this branch and tig in the gitoxide repository that has quite a few merge commits. Is there anything I need to set up to make merge commits more prominent? Does my terminal font need to have certain glyphs?

Also, in tig, vertical lines don’t get cut by horizontal ones, as opposed to guitar. I think I like tig’s approach better. What do you think?

Screenshot_20260407_212543

@philocalyst

philocalyst commented Apr 7, 2026 via email

Copy link
Copy Markdown
Author

@extrawurst

Copy link
Copy Markdown
Collaborator

I also wonder if people like the pressed texts to the facets of the branch lines? I could implement that as well.

Not for now.

The glyphs could expose be exposed as configuration.

Also not relevant for now. Lets find a visual style thats a good default and add customization in a later PR. THis one is big enough as is.

In its current form, I find it hard to see merge commits and how they connect to their respective parents

I agree with this. we either find better symbols or go for the letter M.

Furthermore I think we should use different colored lines for parallel branches like tig does for more clear separation.

@philocalyst

Copy link
Copy Markdown
Author
Screenshot 2026-04-17 at 08 37 30 Screenshot 2026-04-17 at 08 39 29 Screenshot 2026-04-17 at 08 42 16

With the updates, the PR is now looking like the above. Is this a better direction? @extrawurst

I plan to submit a follow-up PR with selection-based highlighting which I think will clear up the remaining vie
wing complexities (As ascii characters can only show so much, realistically). This would look like cutting over the "background" lines when a particular lineage is focused.

@balintbarna

Copy link
Copy Markdown

Hi all, if you need a reference for what looks good and works well in TUI then lazygit (go) and git-igitt (rust) are both very good at visualizing the graph. I think the table layout of lazygit makes more sense:

short hash | timestamp | name | graph | (tags, branches) message

it can also switch between --all mode and current branch
and the colors and highlighting are great
I think it would be a good source of inspiration for the desired look
it also has multi-commit selection by holding down shift and a lot of useful shortcuts on this view, such as squash, fixup, drop, edit, amend, checkout, reset, cherry-pick, which is probably a separate issue from visualizing it, but mentioned it for completeness sake.

https://github.com/jesseduffield/lazygit#commit-graph
https://github.com/git-bahn/git-igitt

image

@philocalyst

Copy link
Copy Markdown
Author

When I looked at the algo's of git-gitt there was some issues around their design as a second-pass over a complete input, which is counter to the streaming design of gitui. Definitely still some issues I realize I miss when I review, I think there's still some issues with connecting pipes, but the tradeoffs of the algorithm feel solid to me.

@balintbarna

balintbarna commented Apr 22, 2026 •

Copy link
Copy Markdown

@philocalyst thanks for your reply. I don't have any insight on the code of the above mentioned projects, my comment is purely from a user perspective.

I'm a software professional and my main way of interacting with git is lazygit, before that I used the integration in vs code with the very popular git graph extension and before that I used source tree. I also briefly tried gitkraken and more recently gitui. I use the CLI when I need to or when it's simpler.

While lazygit has some serious bugs and I disagree with some of their decisions which make me miss git graph from vs code, it is my favourite tool so far, and a big part of that is their graph view, and even if the first version in gitui isn't equivalent, I would like to suggest it as inspiration for what it could become, in addition to the also fantastic git graph extension in vs code and the visually appealing git-igitt.

@philocalyst

philocalyst commented Apr 22, 2026 via email

Copy link
Copy Markdown
Author

@cruessler

Copy link
Copy Markdown
Collaborator

@philocalyst Thanks for the changes! I’ve now started the proper first review which should be ready by today or tomorrow if all goes according to plan! 😀

@philocalyst

philocalyst commented Apr 27, 2026 via email

Copy link
Copy Markdown
Author

@peso

peso commented Apr 27, 2026

Copy link
Copy Markdown
Contributor

Hi there. I'm still working on getting git-graph, now gleisbau, into gitui. The speed requirement from gitui can be solved by splitting the global branch trace algorithm off to a background thread, and then start at head. This will feel as if it starts instantly, but it will traverse the entire repo in due time. The split also addresses the memory issue seen in the gitui+gitgraph prototype from about a year go.

This is a major refactoring, so it will take some time. git-igitt is part of the git-bahn family and uses git-graph/gleisbau under the hood.

I think it is a good idea to get a graph feature into gitui as soon as possible. Everybody wants it. Maybe gleisbau can produce a visual improvement, but the major step is simply getting a graph. Congratulations to @philocalyst for reaching that goal.

@cruessler cruessler left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I’m sorry it’s taking so long! In order to not make you wait longer, I’m now sending you my first batch of comments, hoping they are already useful. As soon as I’m done with the next batch, you’ll get the next round of comments. I hope that works for you!

Comment thread asyncgit/src/graph/oids.rs Outdated
Comment thread asyncgit/src/graph/oids.rs Outdated
Comment thread asyncgit/src/graph/oids.rs Outdated
Comment thread asyncgit/src/graph/mod.rs Outdated
Comment thread asyncgit/src/graph/oids.rs Outdated
@philocalyst

Copy link
Copy Markdown
Author

Balls back in your court! @cruessler

@cruessler

Copy link
Copy Markdown
Collaborator

@philocalyst wrote:
Balls back in your court! @cruessler

Really sorry it’s taking so long, I should be able to devote some time to this PR this week as I don’t have too many other obligations.

@philocalyst

Copy link
Copy Markdown
Author

@cruessler Appreciated! Have another PR I've been sitting on for LFS, but didn't want to overwhelm the team -- so I'll be monitoring my github notifications closely to make sure this week isn't wasted!!

@cruessler cruessler left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I’m slowly getting myself familiar with the PR, in order to make sure I actually understand myself what is going on. 😀 I’ve got a couple of questions and remarks, some more fundamental than others. I’m also going to push minor refactorings that don’t warrant a comment to your branch as well, in order to make some areas more idiomatic. I hope that’s ok, if not, please let me know!

Comment thread asyncgit/src/lib.rs
Comment thread asyncgit/src/revlog.rs Outdated
Comment thread asyncgit/src/graph/walker.rs Outdated
Comment thread asyncgit/src/graph/mod.rs Outdated
Comment thread asyncgit/src/graph/mod.rs
Comment thread asyncgit/src/graph/mod.rs Outdated
Comment thread asyncgit/src/graph/mod.rs Outdated
Comment thread asyncgit/src/graph/chunk.rs Outdated
Comment thread src/components/commitlist.rs
Comment thread asyncgit/src/graph/buffer.rs
Comment thread asyncgit/src/graph/buffer.rs Outdated
@philocalyst

Copy link
Copy Markdown
Author

okay @cruessler you inspired me to do a pretty big refactor so sorry for the delay here! put a ton of effort into reducing the amount of redundant work as far as both clones and passing through the same commits/lanes twice or more. should be totally lazy as far as the graph goes, which i'm very happy to report! there's also a set of tests that should test the basics... (disclosure that i used $llm for the test writing, let me know if this goes against a policy and i will rewrite!)

Also I kind of overpromised with stashes, although I will do in a follow-up if all goes well :)

@philocalyst

Copy link
Copy Markdown
Author

I am also in favor of one! I intend to keep PRing and improving my work, regardless if people find crazy bugs or not.

Use in-place lane updates and end-only growth or trimming so opening a
merge lane does not shift existing columns.

Reuse the nearest column to the right that was already blank above the
current row. Exclude columns freed during the current step because their
closing connectors still occupy that row. Treat vacant slots as absent
when checking upward lane continuity.
Track bridge crossings separately from connections into a lane. Emit a
four-way junction when one bridge joins a lane while another crosses the
same cell, preserving the merge edge.

Move connection-to-glyph selection into the graph-row symbol helper.
Identify an existing second-parent route by the parent a lane awaits,
including lanes whose occupants are themselves merges. Use the same
matching rule as commit placement and bridge routing.

Avoid reserving a duplicate column that would draw an unconnected line.
Store processed status, merge metadata, and the drawable second parent in
CommitFacts. Derive merge markers from Git's parent count, independently
of how many edges can be drawn.

Select up to two distinct unwalked parents, rejecting duplicate,
self-naming, and already-walked entries before allocating lanes. Report
row width from its column span and widen LaneIndex for wide graphs.
Add a shared Scene fixture that checks lane positions, delta validity,
window reconstruction, and graph connectivity before golden comparisons.

Decode rendered characters independently to detect missing parent paths,
dangling lines, unrelated joins, and invalid stacked commits. Cover edge
cases with focused drawings and deterministic generated histories.
Compare lane occupants by owning commit and awaited parent instead of the
whole LaneSlot. A merge slot becoming an ordinary flowing slot keeps its
route and still needs a junction when another bridge reaches that lane.

Add a shared-parent regression and generated histories whose first
parents skip side branches. Extend the sweeps across checkpoint
boundaries.
Add an ignored test that reads git rev-list --parents output from
GITUI_GRAPH_PARENTS and applies the same Scene invariants used for
synthetic histories.

Document how to export and validate a repository's commit history.
Move golden histories, generated topologies, and the optional repository check into dedicated modules. Keep the existing test behavior and filters intact so later logic changes can be reviewed separately.
Resolve each merge's second-parent lane inside Buffer::update using one shared lane lookup. Reserve before closing incoming lanes, eliminating deferred merge state and blank-column tracking while preserving closing corners.

Share delta execution between recording and replay, bound decompression to recorded rows, and cover oversized requests. Add a regression proving that merging HEAD dots only the lane actually heading for HEAD.
Accumulate crossings and joins in a row cell before choosing its final glyph. This removes the lossy glyph-to-directions conversion that made junctions depend on overlay order.

Keep commit markers, vertical lane colors, and dotted crossings intact, with focused tests at the cell abstraction.
Move glyph selection and bridge spacers onto the graph types so the readback tests examine the same picture the log view draws. Preserve spacer colors when empty columns are hidden.

Derive row width from its columns and make lane indices lossless. Retain single-glyph validation and add coverage for column indices beyond u16.
Capture live lane snapshots during the walk and independently derive each row's pending parents from the input history. Compare replayed windows with those snapshots at checkpoint boundaries and validate commit marker selection.

Exercise the fixture with six deliberately corrupted pictures and states, each required to fail at its intended invariant. Check the character decoder directly, reject horizontal lines escaping the picture, and make an explicitly invoked repository test fail on missing or empty input.
The fixture relied on the TLS tool's default certificate extensions.
LibreSSL generated a certificate that gpgsm could import but could not
validate for signing. Declare the self-signed root's CA extension in a
temporary configuration instead of relying on those defaults.

The existing signing and signature-verification assertions now pass with
LibreSSL 3.3.6 and OpenSSL 3.5.8. The full make check target also passes,
including all 363 nextest tests, without excluding the signing test.
Place foldhash in dependency-name order so tombi 0.9.0's format check
passes. Verified with the formatter version used by the CI workflow.
@philocalyst

Copy link
Copy Markdown
Author

all right! added a test harness that check the glyph drawing and attempt to convert it back to the DAG, which immediately proved very useful :) Think it's clever because when we're reading or reviewing that's kind of what we're doing implictly. Used a bit of AI for the initial draft, just a heads-up.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Show the branching structure in the log.

8 participants