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

doc: use .adoc extension for AsciiDoc files

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.

It is much more common to use the ".adoc" extension for AsciiDoc files,
since this helps editors automatically detect files and also allows
various forges to provide rich (HTML-like) rendering.  Let's do that
here, renaming all of the files and updating the includes where
relevant.  Adjust the various build scripts and makefiles to use the new
extension as well.

Note that this should not result in any user-visible changes to the
documentation.

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:56:02 +00:00
committed by Junio C Hamano
parent ed4cf6e8e2
commit 1f010d6bdf
919 changed files with 614 additions and 614 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/lint-gitlink.perl
View File

@ -5,7 +5,7 @@ use warnings;
# Parse arguments, a simple state machine for input like:
#
# <file-to-check.txt> <valid-files-to-link-to> --section=1 git.txt git-add.txt [...] --to-lint git-add.txt a-file.txt [...]
# <file-to-check.adoc> <valid-files-to-link-to> --section=1 git.adoc git-add.adoc [...] --to-lint git-add.adoc a-file.adoc [...]
my %TXT;
my %SECTION;
my $section;
@ -17,7 +17,7 @@ for my $arg (@ARGV) {
next;
}
my ($name) = $arg =~ /^(.*?)\.txt$/s;
my ($name) = $arg =~ /^(.*?)\.adoc$/s;
unless (defined $section) {
$TXT{$name} = $arg;
next;