Re: [PATCH 1/2] doc: refs: put ref migration warning under the command
- From
Patrick Steinhardt <ps@pks.im>
- Date
- Aug 5, 2026, 08:07 UTC
- Message-ID
- <anLvVAyckm7S9Vo0@pks.im>
- In-Reply-To
- <7f34d9b6-de00-44c5-a59c-11f154e7a64a@app.fastmail.com>
On Tue, Aug 04, 2026 at 09:09:25PM +0200, Kristoffer Haugsbakk wrote:
> On Tue, Aug 4, 2026, at 16:30, Patrick Steinhardt wrote:
[snip]
> This is just an informational note and not an argument for using this > particular construct.
Thanks for the explanation!
Show 5 quoted lines
> By the way, I think I looked at the AsciiDoc admonition reference[1] and > saw `CAUTION` and `WARNING`, but now I don’t recall why I chose Caution > over Warning. > > 🔗 1: https://docs.asciidoctor.org/asciidoc/latest/blocks/admonitions/
Hm, interesting. According to the docs, WARNING is to instruct the user of any lingering danger, whereas CAUTION asks them to act carefully. And while the first bullet point is merely a limitation (we cannot migrate worktrees), the second bullet point is indeed a warning that concurrent writers may cause harm. So going by that I think that a WARNING would indeed be a better fit.
Patrick