]> git.ipfire.org Git - thirdparty/git.git/commit
doc: add caveat about turning off commit-graph
authorKristoffer Haugsbakk <code@khaugsbakk.name>
Thu, 7 May 2026 19:42:28 +0000 (21:42 +0200)
committerJunio C Hamano <gitster@pobox.com>
Fri, 8 May 2026 01:22:33 +0000 (10:22 +0900)
commit48c855bb8f17b86188a704cf8c0c5b4f6a316ade
tree092e7c408be10cff711ada0baeeaa3c5dbe08e99
parent94f057755b7941b321fd11fec1b2e3ca5313a4e0
doc: add caveat about turning off commit-graph

The doc `technical/commit-graph.adoc` says that replace objects and
commit grafts turn off commit-graph:

    Commit grafts and replace objects can change the shape of the commit
    history. The latter can also be enabled/disabled on the fly using
    `--no-replace-objects`. This leads to difficulty storing both possible
    interpretations of a commit id, especially when computing generation
    numbers. The commit-graph will not be read or written when
    replace-objects or grafts are present.

But this isn’t mentioned in the user-facing doc. Let’s mention it on
git-replace(1) and git-commit-graph(1).

Acked-by: Derrick Stolee <stolee@gmail.com>
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-commit-graph.adoc
Documentation/git-replace.adoc