Re: [GSoC PATCH v4 0/3] graph: add --graph-lane-limit option
- From
Pablo <pabloosabaterr@gmail.com>
- Date
- Mar 25, 2026, 12:28 UTC
- Message-ID
- <CAN5EUNTXy+cFyHApdrhGKUqrvBGO0bb9X-=MaAWgp4DWOAkA-A@mail.gmail.com>
- In-Reply-To
- <fae2f8e3-029a-43c7-aa6e-45a452026853@kdbg.org>
Johannes Sixt (<j6t@kdbg.org>) writes:
Show 10 quoted lines
> Generally, I like the goal of this patch series. However, the way in > which it is presented and justified can be improved substantially, IMO. > > It begins with the statement of what this patch series wants to achieve. > It is "limit the width of the graph", isn't it? It is not "add > --graph-lane-limit"; that is just a tool to achieve the goal. > > To help reviewers, you should present an example chart in the cover > letter that shows the before- and after-state (with and without the user > of the new option).
True, I'll do that. Because it seems on your last review that I didn't explain myself correctly, the idea was to:
Without --graph-lane-limit:
| | | | | | | * commit message | | | | | |/
With --graph-lane-limit=3:
| | | . commit message | | | .
It truncates the lanes horizontally at the lane limit, the "." replaces everything over the limit (n+1).
Show 9 quoted lines
> As far as the separation into patches is concerned, I see a few > problems. With the current separation is difficult to justify the > patches. For example, the first patch adds prerequisites for a later > patch, but it is unclear how these are used. The answer to the question > "Why do we need this?" is simply "because the next patch uses them", but > this is a very weak justification, because the next questions are "how > are they used and why didn't you squash this into the next patch?" > > Let me suggest a different separation.
I'll merge 1st and 2nd patch together into a single one, adding the option together with the actual logic that does it. This fixes what SZEDER said about the first patch alone breaking the build.
And the documentation + tests on a separate commit.
Show 26 quoted lines
> 1. The first patch limits the graph width with a hard-coded limit, say > 15 lanes. It limits the graph *always*. Choose a limit that is large > enough to pass all tests. > > 2. The next patch adds --graph-lane-limit and its documentation. Let it > do its thing. Revert to the default limit value 0, i.e., unlimited. > > 3. Next, add additional eye-candy. I am alluding to the line that marks > where a graph lane was truncated. > > (4. If more detailed document is warranted, e.g., an example chart, do > this as a separate patch that can now show all bells and whistles that > the earlier commits have implemented. Whether this makes sense as a > separate step, or whether documentation grows with the earlier patches, > is a judgement call.) > > As far as commit messages are concerned, always, always provide an > answer to "Why?" for every detail. > > - Why do we want to limit the graph width? > - Why is the hard-coded limit 15? (because it lets tests pass and is > still a useful limit; we'll make it dynamic later.) > - Why do we always limit the graph width? (Because it makes this patch > simpler; we'll fix this later.) > - Why does 0 mean unlimited? (Consistency with --max-parents.) > - Why is the truncation marked with a fullstop "."? (...)
Ok, I'll make sure to answer clearly all the WHY's on the commits.
Show 5 quoted lines
> I'll also look over the patches, but I don't do C code, so I can provide > only superficial comments, if any. > > -- Hannes >