Git development
 help / color / mirror / Atom feed
From: "Julia Evans" <julia@jvns.ca>
To: "Junio C Hamano" <gitster@pobox.com>
Cc: "Jeff King" <peff@peff.net>,
	"Julia Evans" <gitgitgadget@gmail.com>,
	git@vger.kernel.org
Subject: Re: [PATCH] doc: add more AsciiDoc cross-references
Date: Thu, 24 Sep 2026 13:22:49 -0400	[thread overview]
Message-ID: <31577b6f-79b6-456f-9ecd-d1a3df6209e2@app.fastmail.com> (raw)
In-Reply-To: <xmqqse2y371a.fsf@gitster.g>


> To see if I understand correctly, let me rephrase the second
> paragraph a bit (not as an attempt to offer an improvement; by
> restating the above differently while expressing what I take to be
> the same thing, we will see whether I misunderstood what you wrote
> if my version ends up saying what you did not intend), as I found it
> somewhat puzzling.
>
>     The short form <<EXAMPLES>> uses EXAMPLES as both the link
>     target (which is not shown to the end user except in the
>     browser's location bar when the link is visited) and the
>     clickable text.  In different parts of the document, however,
>     the text in HTML may need to be rendered as "EXAMPLES" or
>     [EXAMPLES], which can be achieved by using the
>     <<EXAMPLES,"EXAMPLES">> or <<EXAMPLES,[EXAMPLES]>> form.  For
>     consistency, always use the longer form, even when there are no
>     such typesetting constraints.

I meant something different, let me try again (with Peff's corrections as well):

    The reason for using the more verbose <<EXAMPLES,EXAMPLES>>
    (instead of <<EXAMPLES>>) is that in some cases, <<EXAMPLES>> is
    rendered as `the section called "EXAMPLES"` or `[EXAMPLES]`.
    <<EXAMPLES,EXAMPLES>> is rendered as just `EXAMPLES`, which gives us
    more control over the output.

("in some cases" is code for "I still don't fully understand
exactly when each one happens and why")

> I'll mark the topic as Expecting a reroll in my working copy of the
> "What's cooking" report of the next issue.
>
> Thanks.

  reply	other threads:[~2026-09-24 17:23 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-09-22 19:29 [PATCH] doc: add more AsciiDoc cross-references Julia Evans via GitGitGadget
2026-09-22 20:20 ` Junio C Hamano
2026-09-22 20:54   ` Julia Evans
2026-09-23 21:40     ` Jeff King
2026-09-24 12:30       ` Julia Evans
2026-09-24 15:55         ` Jeff King
2026-09-24 17:15         ` Junio C Hamano
2026-09-24 17:22           ` Julia Evans [this message]
2026-09-24 18:17             ` Junio C Hamano
2026-09-24 18:42             ` Jeff King
2026-09-23 19:06 ` Kristoffer Haugsbakk
2026-09-23 22:00 ` Jeff King
2026-09-25  0:52 ` [PATCH v2] " Julia Evans via GitGitGadget
2026-09-25  8:27   ` Jeff King
2026-09-25 16:08     ` Rewriting the Git tutorial to cover less content Julia Evans
2026-09-25 16:47       ` Junio C Hamano
2026-09-25 17:25         ` Julia Evans
2026-09-25 18:23           ` Junio C Hamano
2026-09-25 19:22             ` Julia Evans
2026-09-25 19:34               ` Junio C Hamano
2026-09-28 12:21                 ` Julia Evans
2026-09-28 15:16                   ` Junio C Hamano

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=31577b6f-79b6-456f-9ecd-d1a3df6209e2@app.fastmail.com \
    --to=julia@jvns.ca \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    --cc=gitster@pobox.com \
    --cc=peff@peff.net \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox