All of lore.kernel.org
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Jouke Witteveen <j.witteveen@gmail.com>
Cc: Jouke Witteveen via GitGitGadget <gitgitgadget@gmail.com>,
	git@vger.kernel.org
Subject: Re: [PATCH] doc: update references to renamed AsciiDoc files
Date: Thu, 22 May 2025 09:12:59 -0700	[thread overview]
Message-ID: <xmqq34cw7hf8.fsf@gitster.g> (raw)
In-Reply-To: <CAJ2ouazRuF8CGddobgV=xJr8=1RQ4Pv8+ndH0E4qxk-gJhG4AQ@mail.gmail.com> (Jouke Witteveen's message of "Thu, 22 May 2025 11:23:29 +0200")

Jouke Witteveen <j.witteveen@gmail.com> writes:

>> >  The platforms which must be supported by the tool should be aligned with our
>> > -[platform support policy](platform-support.txt).
>> > +xref:platform-support.adoc[platform support policy].
>>
>> ... this one did not stop at "txt" -> "adoc" replacement, but
>> attempts to make a proper link.
>>
>>     Side note: I do not think we are using an explicit xref: syntax
>>     in our documentation anywhere; have you checked how this gets
>>     rendered?
>>
>
> Turns out I was too lazy and blindly replaced what I recognized as a
> Markdown link to the appropriate AsciiDoc link. However, the
> inter-document xref functionality is unavailable in the legacy
> AsciiDoc processor (`asciidoc`) and is disabled in Asciidoctor by our
> use of `--atribute compat-mode`. I'm not sure what the right course of
> action is now. The old link was wrong, but the suggested change only
> starts working when we drop support for `asciidoc` :-(.

Perhaps let the sleeping dog lie for now by doing "txt" -> "adoc"
only, with a bit of comment why we are not doing xref: yet next to
it, perhaps like:

diff --git c/Documentation/technical/build-systems.adoc w/Documentation/technical/build-systems.adoc
index d9dafb407c..3c5237b9fd 100644
--- c/Documentation/technical/build-systems.adoc
+++ w/Documentation/technical/build-systems.adoc
@@ -32,7 +32,10 @@ that generally have somebody running test pipelines against regularly:
   - OpenBSD
 
 The platforms which must be supported by the tool should be aligned with our
-[platform support policy](platform-support.txt).
+platform support policy (see platform-support.adoc).
+// once we lose AsciiDoc compatibility, we can start writing the above as:
+// xref:platform-support.adoc#platform-support-policy[platform support policy]
+// or something like that, but until then....
 
 === Auto-detection of supported features
 

Thanks.

      reply	other threads:[~2025-05-22 16:13 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-05-21 19:05 [PATCH] doc: update references to renamed AsciiDoc files Jouke Witteveen via GitGitGadget
2025-05-21 19:33 ` Junio C Hamano
2025-05-22  9:23   ` Jouke Witteveen
2025-05-22 16:12     ` Junio C Hamano [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqq34cw7hf8.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    --cc=j.witteveen@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.