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 13:14:07 -0800 [thread overview]
Message-ID: <xmqqo6zeixnk.fsf@gitster.g> (raw)
In-Reply-To: <CAGJzqsnFNfK6DEcbRQsUB4S8qVBnQ2PcJBgbvCPYLd-xAVVQBA@mail.gmail.com> (M. Hickford's message of "Thu, 6 Feb 2025 20:33:00 +0000")
M Hickford <mirth.hickford@gmail.com> writes:
> On Mon, 20 Jan 2025 at 01:56, brian m. carlson
> <sandals@crustytoothpaste.net> wrote:
>>
>> We presently use the ".txt" extension for our AsciiDoc files. While not
>> wrong, most editors do not associate this extension with AsciiDoc,
>> meaning that contributors don't get automatic editor functionality that
>> could be useful, such as syntax highlighting and prose linting.
>>
>> It is much more common to use the ".adoc" extension for AsciiDoc files,
>> since this helps editors automatically detect files and also allows
>> various forges to provide rich (HTML-like) rendering. Let's do that
>> here, renaming all of the files and updating the includes where
>> relevant. Adjust the various build scripts and makefiles to use the new
>> extension as well.
>
> 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.
Thanks.
next prev parent reply other threads:[~2025-02-06 21:14 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 [this message]
2025-02-06 23:47 ` Junio C Hamano
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=xmqqo6zeixnk.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).