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>
main
Kristoffer Haugsbakk 2026-05-07 21:42:28 +02:00 committed by Junio C Hamano
parent 94f057755b
commit 48c855bb8f
2 changed files with 13 additions and 0 deletions

View File

@ -146,6 +146,12 @@ $ git show-ref -s | git commit-graph write --stdin-commits
$ git rev-parse HEAD | git commit-graph write --stdin-commits --append
------------------------------------------------

CAVEATS
-------

The existence of replace objects or commit grafts turns off reading or
writing to the commit-graph. See linkgit:git-replace[1].

CONFIGURATION
-------------


View File

@ -145,6 +145,13 @@ commit instead of the replaced commit.
There may be other problems when using 'git rev-list' related to
pending objects.

CAVEATS
-------

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-commit-graph[1].

SEE ALSO
--------
linkgit:git-hash-object[1]