]> git.99rst.org Git - git.git/commit
doc: refs: put ref migration warning under the command
authorKristoffer Haugsbakk <redacted>
Thu, 6 Aug 2026 06:20:21 +0000 (08:20 +0200)
committerJunio C Hamano <redacted>
Thu, 6 Aug 2026 17:32:49 +0000 (10:32 -0700)
commit4cc9039ff094a99aa2754c7b98ba6621079f0ca1
tree18f2a2f79f8bb6a82f1977d6b217d9cce5b580b6
parenta97fcc37c2bc6340a8d7ce78dedf227aac4e9aa7
doc: refs: put ref migration warning under the command

I have to scroll down at least three screens in man(1) from the
`migrate` description in order to see the “known limitations” for
it. This is important information since the text says that concurrent
writes can lead to an inconsistent migrated state. Let’s move that text
up to the command description and put it inside a Warning admonition.

This section made sense when it was added in 25a0023f (builtin/refs:
new command to migrate ref storage formats, 2024-06-06); `migrate` was
the only subcommand, and this section was visible from the command
description. A one-page man page. But that is not the case anymore
now that the command has nine subcommands to describe.

Acked-by: Patrick Steinhardt <redacted>
Signed-off-by: Kristoffer Haugsbakk <redacted>
Signed-off-by: Junio C Hamano <redacted>
Documentation/git-refs.adoc
git clone https://git.99rst.org/PROJECT