diff options
| author | brian m. carlson <sandals@crustytoothpaste.net> | 2025-01-20 01:56:02 +0000 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2025-01-21 12:56:06 -0800 |
| commit | 1f010d6bdf756129db13d1367c888aa4153f6d87 (patch) | |
| tree | 715708841b4980198157a60e72028e25a0059177 /Documentation/install-webdoc.sh | |
| parent | gitattributes: mark AsciiDoc files as LF-only (diff) | |
| download | git-1f010d6bdf756129db13d1367c888aa4153f6d87.tar.gz git-1f010d6bdf756129db13d1367c888aa4153f6d87.zip | |
doc: use .adoc extension for AsciiDoc files
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>
Diffstat (limited to 'Documentation/install-webdoc.sh')
| -rwxr-xr-x | Documentation/install-webdoc.sh | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/Documentation/install-webdoc.sh b/Documentation/install-webdoc.sh index ed8b4ff3e5..b237b311c3 100755 --- a/Documentation/install-webdoc.sh +++ b/Documentation/install-webdoc.sh @@ -3,10 +3,10 @@ T="$1" for h in \ - *.txt *.html \ - howto/*.txt howto/*.html \ - technical/*.txt technical/*.html \ - RelNotes/*.txt *.css + *.adoc *.html \ + howto/*.adoc howto/*.html \ + technical/*.adoc technical/*.html \ + RelNotes/*.adoc *.css do if test ! -f "$h" then @@ -24,13 +24,13 @@ do done strip_leading=$(echo "$T/" | sed -e 's|.|.|g') for th in \ - "$T"/*.html "$T"/*.txt \ - "$T"/howto/*.txt "$T"/howto/*.html \ - "$T"/technical/*.txt "$T"/technical/*.html + "$T"/*.html "$T"/*.adoc \ + "$T"/howto/*.adoc "$T"/howto/*.html \ + "$T"/technical/*.adoc "$T"/technical/*.html do h=$(expr "$th" : "$strip_leading"'\(.*\)') case "$h" in - RelNotes-*.txt | index.html) continue ;; + RelNotes-*.adoc | index.html) continue ;; esac test -f "$h" && continue echo >&2 "# rm -f $th" |
