* [PATCH] docs: add vim syntax modeline [RFC]
@ 2025-01-13 21:03 M Hickford via GitGitGadget
2025-01-13 21:33 ` brian m. carlson
2025-01-13 22:37 ` D. Ben Knoble
0 siblings, 2 replies; 6+ messages in thread
From: M Hickford via GitGitGadget @ 2025-01-13 21:03 UTC (permalink / raw)
To: git; +Cc: M Hickford, M Hickford
From: M Hickford <mirth.hickford@gmail•com>
Git documentation is written in AsciiDoc. This format is easily
mistaken for the pervasive Markdown.
Add a vim modeline to help editors identify the format and provide
syntax highlighting, rendering and autocomplete.
This makes editing the documentation easier for prospective
contributors. This is particularly important because new contributors
often start with documentation changes.
An alternative could be to move the modeline up or down the file (the
location is not important).
A simpler alternative could be to rename files *.adoc. This would have
the advantage of being recognised by even more tools.
Signed-off-by: M Hickford <mirth.hickford@gmail•com>
---
docs: add vim syntax modeline [RFC]
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1874%2Fhickford%2Fasciidoc-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1874/hickford/asciidoc-v1
Pull-Request: https://github.com/git/git/pull/1874
Documentation/git-add.txt | 1 +
1 file changed, 1 insertion(+)
diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt
index 5f2c3592b8d..123c98541b1 100644
--- a/Documentation/git-add.txt
+++ b/Documentation/git-add.txt
@@ -1,5 +1,6 @@
git-add(1)
==========
+// vim: syntax=asciidoc
NAME
----
base-commit: fbe8d3079d4a96aeb4e4529cc93cc0043b759a05
--
gitgitgadget
^ permalink raw reply related [flat|nested] 6+ messages in thread* Re: [PATCH] docs: add vim syntax modeline [RFC] 2025-01-13 21:03 [PATCH] docs: add vim syntax modeline [RFC] M Hickford via GitGitGadget @ 2025-01-13 21:33 ` brian m. carlson 2025-01-13 22:50 ` M Hickford 2025-01-13 22:52 ` Junio C Hamano 2025-01-13 22:37 ` D. Ben Knoble 1 sibling, 2 replies; 6+ messages in thread From: brian m. carlson @ 2025-01-13 21:33 UTC (permalink / raw) To: M Hickford via GitGitGadget; +Cc: git, M Hickford [-- Attachment #1: Type: text/plain, Size: 2007 bytes --] On 2025-01-13 at 21:03:14, M Hickford via GitGitGadget wrote: > From: M Hickford <mirth.hickford@gmail•com> > > Git documentation is written in AsciiDoc. This format is easily > mistaken for the pervasive Markdown. > > Add a vim modeline to help editors identify the format and provide > syntax highlighting, rendering and autocomplete. I don't think this is a good idea. To be clear, I use Vim and Neovim (mostly the latter), but I just don't think we should litter our project with editor-specific contents. I know Junio uses Emacs, and other contributors use other things, and there's no uniform syntax that works everywhere. (Nor could there be, because different editors have different names for different languages.) We also don't set editor-specific ignore files in our `.gitignore`. Emacs users are responsible for ignoring backup files in the global (per-user) config, Vim users for swap files, and so on. > This makes editing the documentation easier for prospective > contributors. This is particularly important because new contributors > often start with documentation changes. I suspect prospective contributors who are moderately proficient with Vim and its descendants know how to do `:setf asciidoc`. If this were a different editor that were easier to start with (say, one that didn't have tons of Internet posts asking how to quit it), such as VS Code or even Emacs, then I would be more convinced by this argument. > A simpler alternative could be to rename files *.adoc. This would have > the advantage of being recognised by even more tools. This I would be in favour of. I use this extension on my personal AsciiDoc files and already have appropriate configuration set up. In conjunction with appropriate settings in our `.editorconfig` file (to configure indents properly), I think this would be valuable indeed, and, importantly, helpful to users of all editors. -- brian m. carlson (they/them or he/him) Toronto, Ontario, CA [-- Attachment #2: signature.asc --] [-- Type: application/pgp-signature, Size: 263 bytes --] ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] docs: add vim syntax modeline [RFC] 2025-01-13 21:33 ` brian m. carlson @ 2025-01-13 22:50 ` M Hickford 2025-01-13 22:52 ` Junio C Hamano 1 sibling, 0 replies; 6+ messages in thread From: M Hickford @ 2025-01-13 22:50 UTC (permalink / raw) To: brian m. carlson, M Hickford via GitGitGadget, git On 2025-01-13 21:33, brian m. carlson wrote: > On 2025-01-13 at 21:03:14, M Hickford via GitGitGadget wrote: >> From: M Hickford <mirth.hickford@gmail•com> >> >> Git documentation is written in AsciiDoc. This format is easily >> mistaken for the pervasive Markdown. >> >> Add a vim modeline to help editors identify the format and provide >> syntax highlighting, rendering and autocomplete. > > I don't think this is a good idea. To be clear, I use Vim and Neovim > (mostly the latter), but I just don't think we should litter our project > with editor-specific contents. I know Junio uses Emacs, and other > contributors use other things, and there's no uniform syntax that works > everywhere. (Nor could there be, because different editors have > different names for different languages.) > > We also don't set editor-specific ignore files in our `.gitignore`. > Emacs users are responsible for ignoring backup files in the global > (per-user) config, Vim users for swap files, and so on. > >> This makes editing the documentation easier for prospective >> contributors. This is particularly important because new contributors >> often start with documentation changes. > > I suspect prospective contributors who are moderately proficient with > Vim and its descendants know how to do `:setf asciidoc`. If this were a > different editor that were easier to start with (say, one that didn't > have tons of Internet posts asking how to quit it), such as VS Code or > even Emacs, then I would be more convinced by this argument. > >> A simpler alternative could be to rename files *.adoc. This would have >> the advantage of being recognised by even more tools. > > This I would be in favour of. I use this extension on my personal > AsciiDoc files and already have appropriate configuration set up. In > conjunction with appropriate settings in our `.editorconfig` file (to > configure indents properly), I think this would be valuable indeed, and, > importantly, helpful to users of all editors. The more I think about it, I prefer renaming to *.adoc too. It's easy to identify and obviously distinct from Markdown. GitHub and GitLab render adoc files beautifully [1][2]. Visual Studio Code offers to install an extension with syntax highlighting and previewing. The vim modeline had no effect in Visual Studio Code. It could also be intimidating. [1] https://github.com/couchbase-guides/how-to-write-a-guide/blob/master/README.adoc [2] https://docs.gitlab.com/ee/user/asciidoc.html ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] docs: add vim syntax modeline [RFC] 2025-01-13 21:33 ` brian m. carlson 2025-01-13 22:50 ` M Hickford @ 2025-01-13 22:52 ` Junio C Hamano 2025-01-16 18:55 ` M Hickford 1 sibling, 1 reply; 6+ messages in thread From: Junio C Hamano @ 2025-01-13 22:52 UTC (permalink / raw) To: brian m. carlson; +Cc: M Hickford via GitGitGadget, git, M Hickford "brian m. carlson" <sandals@crustytoothpaste•net> writes: >> A simpler alternative could be to rename files *.adoc. This would have >> the advantage of being recognised by even more tools. > > This I would be in favour of. Sounds quite sensible. Thanks. ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] docs: add vim syntax modeline [RFC] 2025-01-13 22:52 ` Junio C Hamano @ 2025-01-16 18:55 ` M Hickford 0 siblings, 0 replies; 6+ messages in thread From: M Hickford @ 2025-01-16 18:55 UTC (permalink / raw) To: Junio C Hamano Cc: brian m. carlson, M Hickford via GitGitGadget, git, M Hickford, Patrick Steinhardt, Johannes Schindelin On Mon, 13 Jan 2025 at 22:52, Junio C Hamano <gitster@pobox•com> wrote: > > "brian m. carlson" <sandals@crustytoothpaste•net> writes: > > >> A simpler alternative could be to rename files *.adoc. This would have > >> the advantage of being recognised by even more tools. > > > > This I would be in favour of. > > Sounds quite sensible. Great, we seem to have reached a consensus in favour of renaming Documentation AsciiDoc files to *.adoc. I'll leave this to someone more familiar with the documentation build process (or patient to experiment). #leftoverbits ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] docs: add vim syntax modeline [RFC] 2025-01-13 21:03 [PATCH] docs: add vim syntax modeline [RFC] M Hickford via GitGitGadget 2025-01-13 21:33 ` brian m. carlson @ 2025-01-13 22:37 ` D. Ben Knoble 1 sibling, 0 replies; 6+ messages in thread From: D. Ben Knoble @ 2025-01-13 22:37 UTC (permalink / raw) To: M Hickford via GitGitGadget; +Cc: git, M Hickford, brian m . carlson On Mon, Jan 13, 2025 at 4:05 PM M Hickford via GitGitGadget <gitgitgadget@gmail•com> wrote: > > From: M Hickford <mirth.hickford@gmail•com> > > Git documentation is written in AsciiDoc. This format is easily > mistaken for the pervasive Markdown. > > Add a vim modeline to help editors identify the format and provide > syntax highlighting, rendering and autocomplete. FWIW, Vim by default only has a single autocommand for *.txt files, and it's to see if they are help files. Now, there is a fallback $VIMRUNTIME/scripts.vim mechanism that performs various "heuristic" checks, but I can't find a reference to markdown in it either. So stock Vim treats them as "filetype=text." > > This makes editing the documentation easier for prospective > contributors. This is particularly important because new contributors > often start with documentation changes. > > An alternative could be to move the modeline up or down the file (the > location is not important). Not quite. :help modeline says The number of lines that are checked can be set with the 'modelines' option. If 'modeline' is off or 'modelines' is 0 no lines are checked. and the default value of 'modelines' is 5. > > A simpler alternative could be to rename files *.adoc. This would have > the advantage of being recognised by even more tools. Indeed, Vim knows that *.adoc and *.asciidoc are "filetype=asciidoc". You could also see about submitting a patch to Vim to check *.txt files for asciidoc syntax, or add your own ftdetect rules [1] that say that files with %:p matching "git.*/Documentation" (for example) get the filetype asciidoc. [1]: https://vi.stackexchange.com/a/23251/10604, https://vi.stackexchange.com/a/18493/10604, https://vi.stackexchange.com/a/28109/10604, etc. -- D. Ben Knoble ^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2025-01-16 18:56 UTC | newest] Thread overview: 6+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2025-01-13 21:03 [PATCH] docs: add vim syntax modeline [RFC] M Hickford via GitGitGadget 2025-01-13 21:33 ` brian m. carlson 2025-01-13 22:50 ` M Hickford 2025-01-13 22:52 ` Junio C Hamano 2025-01-16 18:55 ` M Hickford 2025-01-13 22:37 ` D. Ben Knoble
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox