[PATCH 1/5] doc: update gitignore for .adoc extension

From: brian m. carlson <sandals@crustytoothpaste.net>
Date: Jan 20, 2025, 01:55 UTC
Message-ID: <20250120015603.1980991-2-sandals@crustytoothpaste.net>
In-Reply-To: <20250120015603.1980991-1-sandals@crustytoothpaste.net>

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>
---
 Documentation/.gitignore           | 4 ++++
 Documentation/technical/.gitignore | 1 +
 2 files changed, 5 insertions(+)

diff --git a/Documentation/.gitignore b/Documentation/.gitignore
index 9f4bb3c4bf..abce806398 100644
--- a/Documentation/.gitignore
+++ b/Documentation/.gitignore
@@ -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
diff --git a/Documentation/technical/.gitignore b/Documentation/technical/.gitignore
index 8aa891daee..3caef14a93 100644
--- a/Documentation/technical/.gitignore
+++ b/Documentation/technical/.gitignore
@@ -1 +1,2 @@
 api-index.txt
+api-index.adoc