git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
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
Subject: Re: [PATCH 1/3] doc: git-rev-parse: enforce command-line description syntax
Date: Thu, 22 Feb 2024 08:38:36 -0800	[thread overview]
Message-ID: <xmqqr0h4h2sz.fsf@gitster.g> (raw)
In-Reply-To: <2926790.e9J7NaK4W3@cayenne> ("Jean-Noël AVILA"'s message of "Thu, 22 Feb 2024 10:07:53 +0100")

Jean-Noël AVILA <jn.avila@free.fr> writes:

>> So, perhaps we do not have to do a lot of 'word' -> _word_
>> replacements, hopefully?

> ... At least, we 
> should try to stick as much as possible to the common markup _ for emphasis.

OK, that clears up my confusion.  Thanks.

We do not want to rely on an external party indefinitely maintaining
what they consider backward compatibility wart, so the mark-up migration
would need to happen before it becomes too late.

> This would have the added benefit of differentiating single quotes from 
> backticks, because single quotes would completely disappear in the end, except 
> when a real single quote is needed.

Given enough time, yes.  Or we can actively disable AsciiDoctor's
compatibility mode and/or tweak asciidoc.conf to do the equivalent
for AsciiDoc, to start early.  Until then, we cannot really use "a
real single quote", right?

> For the migration to "standard" asciidoc, I would also recommend using "=" 
> prefix for titles instead of underlines which require changing two lines when 
> modifying  a title and are a pain for translators in languages with variable 
> width characters.

I personally strongly prefer the underline format because I care
about readability of sources, but that is just me.  Is that also
getting deprecated?

Thanks.

  reply	other threads:[~2024-02-22 16:38 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-02-20 22:32 [PATCH 0/3] Doc placeholders Jean-Noël Avila via GitGitGadget
2024-02-20 22:32 ` [PATCH 1/3] doc: git-rev-parse: enforce command-line description syntax Jean-Noël Avila via GitGitGadget
2024-02-20 22:57   ` Junio C Hamano
2024-02-21  7:41     ` Jean-Noël Avila
2024-02-21 17:31       ` Junio C Hamano
2024-02-21 21:52         ` Jean-Noël AVILA
2024-02-21 22:36         ` Junio C Hamano
2024-02-22  9:07           ` Jean-Noël AVILA
2024-02-22 16:38             ` Junio C Hamano [this message]
2024-02-24 18:28               ` Jean-Noël AVILA
2024-02-20 22:32 ` [PATCH 2/3] doc: git-clone fix missing placeholder end carret Jean-Noël Avila via GitGitGadget
2024-02-20 22:39   ` Eric Sunshine
2024-02-20 23:01     ` Junio C Hamano
2024-02-20 22:32 ` [PATCH 3/3] doc: add some missing sentence dots Jean-Noël Avila via GitGitGadget
2024-02-20 22:50   ` 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=xmqqr0h4h2sz.fsf@gitster.g \
    --to=gitster@pobox.com \
    --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).