Re: [PATCH 4/5] doc: use .adoc extension for AsciiDoc files
- From
brian m. carlson <sandals@crustytoothpaste.net>
- Date
- Jan 20, 2025, 22:08 UTC
- Message-ID
- <Z47JUbdzMtz1CTMg@tapette.crustytoothpaste.net>
- In-Reply-To
- <46cec27d-ee66-4dfb-8271-953b032d0b2f@free.fr>
On 2025-01-20 at 20:37:10, Jean-Noël Avila wrote:
> 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.
I appreciate that this is a big change, but we do also sometimes make those and contributors and downstreams need to change over eventually.
Show 9 quoted lines
> 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))))Vim doesn't offer a secure way to do this. There's the `.exrc` file, which is not generally secure because setting `exrc` applies to all directories and allows arbitrary Vimscript (and thus, arbitrary code execution), and modelines, which we've already rejected, since they're editor-specific.
You could, of course, put the configuration in your `.vimrc` with an autocommand for Git's worktree, but it's pretty gross to have to special-case one project in your dotfiles, and I don't think that's a general solution here.
I appreciate that Emacs may provide this functionality, but we also have to deal with a variety of editors that don't.
> Maybe a smoother transition could be performed by creating links between > txt and adoc files.
I'd prefer if we didn't do that, but we could. My concern is that will actually make the patch even larger, possibly to the point it might not fit on the list.
We'll also want to eventually drop the symlinks if we add them now, which means that the breaking changes you mentioned above that you didn't want to make will need to be made eventually. Is it that you want more of a grace period to do that, or that you're opposed to having to make the change at all?
-- brian m. carlson (they/them or he/him) Toronto, Ontario, CA