]> git.ipfire.org Git - thirdparty/git.git/commit
doc: refs: put ref migration warning under the command
authorKristoffer Haugsbakk <code@khaugsbakk.name>
Fri, 31 Jul 2026 09:07:02 +0000 (11:07 +0200)
committerJunio C Hamano <gitster@pobox.com>
Fri, 31 Jul 2026 16:22:43 +0000 (09:22 -0700)
commit65edea454e1e767ec962f279c251aa7c29359f5d
treea2c7658f99e7a9eff60146b99cead2e9beebd2d2
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 Caution 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.

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-refs.adoc