Re: [PATCH] doc: add caveat about turning off commit-graph
- From
Derrick Stolee <stolee@gmail.com>
- Date
- May 7, 2026, 18:03 UTC
- Message-ID
- <0b67df77-b0c8-47dd-ace5-8dd80474bbe6@gmail.com>
- In-Reply-To
- <3f0e03e4-f1ca-4010-aacf-72b3ce0aebd1@app.fastmail.com>
On 5/7/2026 10:30 AM, Kristoffer Haugsbakk wrote:
Show 26 quoted lines
> On Wed, May 6, 2026, at 15:59, Derrick Stolee wrote: >>> [snip] >>> >>> But this isn’t mentioned in the user-facing doc. Let’s mention it on >>> git-replace(1) and git-commit-graph(1). >> >> I like your initiative to present this incompatibility in the >> user-facing docs. >> >>> +CAVEATS >>> +------- >>> + >>> +The existence of replace objects or commit grafts turns off reading or >>> +writing to the commit-graph. See linkgit:git-replace[1]. >>> + >> This does seem a little weak. It doesn't really say how this will >> impact the user. Perhaps we could add something about how performance >> will likely degrade in this mode? >> >> The existence of replace objects or commit grafts turns off reading or >> writing to the commit-graph, which can cause performance issues. See >> linkgit:git-replace[1]. > > Thanks, that’s good. But I think this addition makes sense only on > git-replace(1). In this (example) git-commit-graph(1) case the whole doc > already explains what the commit-graph is about.
That's fair. Thanks! -Stolee