Re: [PATCH 4/5] doc: use .adoc extension for AsciiDoc files

From: Jean-Noël Avila <jn.avila@free.fr>
Date: Jan 20, 2025, 20:37 UTC
Message-ID: <46cec27d-ee66-4dfb-8271-953b032d0b2f@free.fr>
In-Reply-To: <20250120015603.1980991-5-sandals@crustytoothpaste.net>

Le 20/01/2025 à 02:56, brian m. carlson a écrit :

Show 15 quoted lines

> 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.
> 
> Note that this should not result in any user-visible changes to the
> documentation.
>

Maybe for users of the end product of the documentations compiled here, but there are other users who use the source files and this change breaks their workflow pretty bad. I am one of those users for the git-scm.com website and the manpage translation projects.

If the purpose of this change is clear, the breakage of backward compatibility is an issue. When documentation writers know how to turn on the asciidoc mode in their editor, they surely know how to enable it on .txt files in this specifically in this directory.

For instance in emacs, create a `.dir-locals.el` in the Documentation directory with the following line:

((auto-mode-alist . (("\\.txt\\'" .  adoc-mode))))

Maybe a smoother transition could be performed by creating links between txt and adoc files.

JN