mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: update gitignore for .adoc extension

Browse Source 
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.

Instead, in a future commit, we're going to move to using the more
common ".adoc" extension for these files, which many editors
intrinsically recognize as an AsciiDoc file.  To avoid contributors
accidentally checking in generated files, ignore the new extension for
generated files in the documentation .gitignore files.

Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
brian m. carlson
2025-01-20 01:55:59 +00:00
committed by Junio C Hamano
parent 757161efcc
commit 89cdbffa86
2 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/.gitignore vendored
View File

@ -7,10 +7,14 @@
git.info
gitman.info
howto-index.txt
howto-index.adoc
doc.dep
cmds-*.txt
cmds-*.adoc
mergetools-*.txt
mergetools-*.adoc
SubmittingPatches.txt
SubmittingPatches.adoc
tmp-doc-diff/
tmp-meson-diff/
GIT-ASCIIDOCFLAGS

1
Documentation/technical/.gitignore vendored
View File

@ -1 +1,2 @@
api-index.txt
api-index.adoc