Re: [PATCH 4/5] doc: use .adoc extension for AsciiDoc files
- From
D. Ben Knoble <ben.knoble@gmail.com>
- Date
- Feb 7, 2025, 17:51 UTC
- Message-ID
- <CALnO6CAa+6xx885TdKFrpruxHbN80S3RE=STaswnaUz_3QZQ=Q@mail.gmail.com>
- In-Reply-To
- <xmqqo6zeixnk.fsf@gitster.g>
On Thu, Feb 6, 2025 at 4:14 PM Junio C Hamano <gitster@pobox.com> wrote:
Show 25 quoted lines
> > 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 don't know how (I didn't dig), but we do build and package HTML-ified SubmittingPatches as both $(git --html-path)/SubmittingPatches.{html,txt}. I don't see a build output for CodingGuidelines, though. (We also package ReviewingGuidelines.{html,txt}, but it has a .txt extension.)
-- D. Ben Knoble