Re: [PATCH] doc: add caveat about turning off commit-graph
- From
- Kristoffer Haugsbakk <kristofferhaugsbakk@fastmail.com>
- Date
- May 7, 2026, 14:30 UTC
- Message-ID
- <3f0e03e4-f1ca-4010-aacf-72b3ce0aebd1@app.fastmail.com>
- In-Reply-To
- <5f9f4998-4538-4bc1-a245-4248e18c4e86@gmail.com>
On Wed, May 6, 2026, at 15:59, Derrick Stolee wrote:
Show 21 quoted lines
>>[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.