git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: M Hickford <mirth.hickford@gmail.com>
Cc: "brian m. carlson" <sandals@crustytoothpaste.net>,  git@vger.kernel.org
Subject: Re: [PATCH 4/5] doc: use .adoc extension for AsciiDoc files
Date: Thu, 06 Feb 2025 15:47:13 -0800	[thread overview]
Message-ID: <xmqqh656hbzy.fsf@gitster.g> (raw)
In-Reply-To: <xmqqo6zeixnk.fsf@gitster.g> (Junio C. Hamano's message of "Thu, 06 Feb 2025 13:14:07 -0800")

Junio C Hamano <gitster@pobox.com> writes:

>> Hi Brian. How about also renaming SubmittingPatches to
>> SubmittingPatches.adoc? This is AsciiDoc according to 049e64aa50
>> (Documentation: convert SubmittingPatches to AsciiDoc, 2017-11-12).
>
> Do we pass SubmittingPatches (and CodingGuidelines for that matter)
> through AsciiDoc?  They do not even have .txt suffix, so I suspect
> it is not.
>
> I would prefer to see the general rule to be to rename s/txt/adoc/
> ONLY for files that we actually use AsciiDoc to convert to HTML or
> manpages, and leave other sleeping dogs unmolested.

The above is for ultra short-term.

Once the main part of the documentation changes to .adoc graduates
to 'master', I do not mind another topic that updates those without
the .txt suffix to learn to be formatted with AsciiDoc.  And as a
part of such an effort, such files will gain the .adoc suffix since
that is how the Makefile finds which files to format with AsciiDoc.

We might decide not to format them with AsciiDoc simply because we
have nowhere to _install_ them, though.  Even in such a case, we may
still want to give them the .adoc suffix, just to help editors.

Thanks.

  reply	other threads:[~2025-02-06 23:47 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-01-20  1:55 [PATCH 0/5] Convert AsciiDoc files to .adoc extension brian m. carlson
2025-01-20  1:55 ` [PATCH 1/5] doc: update gitignore for " brian m. carlson
2025-01-20  1:56 ` [PATCH 2/5] editorconfig: add " brian m. carlson
2025-01-20  1:56 ` [PATCH 3/5] gitattributes: mark AsciiDoc files as LF-only brian m. carlson
2025-01-20  1:56 ` [PATCH 4/5] doc: use .adoc extension for AsciiDoc files brian m. carlson
2025-01-20 20:37   ` Jean-Noël Avila
2025-01-20 22:08     ` brian m. carlson
2025-01-20 23:43       ` Junio C Hamano
2025-01-21 21:59         ` Jean-Noël Avila
2025-02-06 20:33   ` M Hickford
2025-02-06 21:14     ` Junio C Hamano
2025-02-06 23:47       ` Junio C Hamano [this message]
2025-02-07 17:51       ` D. Ben Knoble
2025-02-07 18:05         ` Junio C Hamano
2025-02-07 18:29           ` Junio C Hamano
2025-02-07 22:54           ` brian m. carlson
2025-01-20  1:56 ` [PATCH 5/5] Remove obsolete ".txt" extensions " brian m. carlson
2025-01-20 17:55 ` [PATCH 0/5] Convert AsciiDoc files to .adoc extension M Hickford
2025-01-20 20:19 ` D. Ben Knoble

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=xmqqh656hbzy.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=mirth.hickford@gmail.com \
    --cc=sandals@crustytoothpaste.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;
as well as URLs for NNTP newsgroup(s).