From: Junio C Hamano <gitster@pobox.com>
To: "Jean-Noël Avila" <jn.avila@free.fr>
Cc: "Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail.com>,
git@vger.kernel.org,
"Johannes Schindelin" <Johannes.Schindelin@gmx.de>
Subject: Re: [PATCH] doc: git-clone fix discrepancy between asciidoc and asciidoctor
Date: Tue, 23 Jul 2024 08:52:31 -0700 [thread overview]
Message-ID: <xmqqv80w2ji8.fsf@gitster.g> (raw)
In-Reply-To: <89d00235-71db-4087-8ffb-7e93c3f470a0@free.fr> ("Jean-Noël Avila"'s message of "Tue, 23 Jul 2024 13:06:06 +0200")
Jean-Noël Avila <jn.avila@free.fr> writes:
> Please hold on this patch. Cranking on your reflections about the ugly
> markup and upon advice from Dan Allen (of asciidoctor) [1], I'd like to
> push another way of managing the files, which would be to define a
> custom 'synopsis' paragraph style which would allow to process
> automatically the grammar.
Sounds good. Anything that lets documenters write what they mean
without involving an absolute nightmare of a markup sequence is what
we want here.
But I'd like to see such a larger scale work early in the next
cycle, not close to the end of this cycle a few days before -rc2.
In the meantime, I am tempted to
(1) apply Dscho's CSS change (but with fixes to avoid "make
distclean" issue) and leaving git-clone as-is. or
(2) revert the git-clone and git-init mark-up patches (76880f05
(doc: git-clone: apply new documentation formatting guidelines,
2024-03-29) and (5cf7dfe9 (doc: git-init: apply new
documentation formatting guidelines, 2024-03-29), which suffers
from the <code> being blocks. This will allow us not to worry
about CSS change proposed by Dscho this close to the final. or
(3) do nothing.
I'd probably do (1). Even though chances of unintended regression
might be smaller with (2), which would only affect clone and init
manual pages (as opposed to anything that uses <code> inside <pre>),
it's less work (and more work to validate the result visually, which
may be a pain).
> [1]
> https://asciidoctor.zulipchat.com/#narrow/stream/279642-users/topic/Is.20there.20a.20way.20to.20disable.20role.20attributes.3F
I've always felt [verse] was a bad choice (I honestly do not know
where its use came from), and I am glad to finally find somebody
agreeing ;-)
Thanks.
next prev parent reply other threads:[~2024-07-23 15:52 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-07-20 17:34 [PATCH] doc: git-clone fix discrepancy between asciidoc and asciidoctor Jean-Noël Avila via GitGitGadget
2024-07-20 23:16 ` Junio C Hamano
2024-07-20 23:23 ` Junio C Hamano
2024-07-21 13:08 ` Jean-Noël AVILA
2024-07-22 16:39 ` Junio C Hamano
2024-07-23 11:06 ` Jean-Noël Avila
2024-07-23 15:52 ` Junio C Hamano [this message]
2024-07-23 17:44 ` Junio C Hamano
2024-07-23 17:47 ` Eric Sunshine
2024-07-23 18:04 ` 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=xmqqv80w2ji8.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=Johannes.Schindelin@gmx.de \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=jn.avila@free.fr \
/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).