[PATCH] docs: add vim syntax modeline [RFC]

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(+)