From: Junio C Hamano <gitster@pobox.com>
To: Ramsay Jones <ramsay@ramsayjones.plus.com>
Cc: GIT Mailing-list <git@vger.kernel.org>,
Patrick Steinhardt <ps@pks.im>,
Derrick Stolee <stolee@gmail.com>
Subject: Re: [RFC PATCH 4/4] doc: commit-graph.adoc: fix up some formatting
Date: Fri, 26 Sep 2025 14:21:24 -0700 [thread overview]
Message-ID: <xmqqwm5kap0r.fsf@gitster.g> (raw)
In-Reply-To: <c8e40336-0a16-4da9-b251-d166f80ffeb3@ramsayjones.plus.com> (Ramsay Jones's message of "Fri, 26 Sep 2025 19:11:57 +0100")
Ramsay Jones <ramsay@ramsayjones.plus.com> writes:
> I tried searching the web for the answer, without success, so went with
> the 'prefix' style used here. However, when I read the above, it made me
> look at out current docs and gitworkflows.adoc showed me I should have
> used an '~' character instead.
>
> I just tried this and it works great (apart from having to \-quote the
> '{' and '}' characters in one title), so a revised 'diff' is given below.
Oy. It is one of the special things I am unsure about---would a
character used for such quoting (e.g., backslash in this case) count
as one display space to count the number of underlying characters?
That is, which one of these do AsciiDoc and Asciidoctor want?
Deleting graph-\{hash\} files
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Deleting graph-\{hash\} files
~~~~~~~~~~~~~~~~~~~~~~~~~~~--
There is
OPTIONS[[OPTIONS]]
------------------
that appears in MyFirstContribution.adoc (even though that is an
illustration of what you would write in the source and never used),
and
`builtin_objectmode`
~~~~~~~~~~~~~~~~~~~~
that appears in gitattributes.adoc (this one is rendered), so I've
been assuming that these characters necessary for mark-up do count.
I guess this is the same "prefix is easier to write, underling is
harder to write correctly" theme? If we know which one is correct
and can use the correct version, then I do prefer the underlined
form.
Thanks.
next prev parent reply other threads:[~2025-09-26 21:21 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-09-26 0:28 [RFC PATCH 4/4] doc: commit-graph.adoc: fix up some formatting Ramsay Jones
2025-09-26 15:52 ` Junio C Hamano
2025-09-26 18:11 ` Ramsay Jones
2025-09-26 21:21 ` Junio C Hamano [this message]
2025-09-26 23:30 ` Ramsay Jones
2025-09-27 1:36 ` 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=xmqqwm5kap0r.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=ps@pks.im \
--cc=ramsay@ramsayjones.plus.com \
--cc=stolee@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).