From: "M Hickford via GitGitGadget" <gitgitgadget@gmail•com>
To: git@vger•kernel.org
Cc: M Hickford <mirth.hickford@gmail•com>,
M Hickford <mirth.hickford@gmail•com>
Subject: [PATCH] docs: add vim syntax modeline [RFC]
Date: Mon, 13 Jan 2025 21:03:14 +0000 [thread overview]
Message-ID: <pull.1874.git.git.1736802194760.gitgitgadget@gmail.com> (raw)
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
next reply other threads:[~2025-01-13 21:03 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-01-13 21:03 M Hickford via GitGitGadget [this message]
2025-01-13 21:33 ` [PATCH] docs: add vim syntax modeline [RFC] 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
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=pull.1874.git.git.1736802194760.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=mirth.hickford@gmail$(echo .)com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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