[0/3] doc: txt -> adoc fixes

Message

Todd Zullinger Feb. 28, 2025, 3:47 a.m. UTC

I noticed broken links in the howto-index.html output of v2.49.0-rc0.
This is due to the recent txt -> adoc renaming.  I chose to replace the
numerous occurences of "txt" with "adoc" in howto-index.sh for consistency
within the script.  It could be argued that only the few instances which
glob '*.txt' should be changed, of course.

I also renamed the git-*.txt files in contrib/contacts and contrib/subtree
while I was here.  The only other file in contrib which might warrant that
treatment is contrib/mw-to-git/git-remote-mediawiki.txt.  I skipped it as
I am not sure whether it is actively maintained anymore.  If we want to
rename it to be consistent, that's easy enough.

Todd Zullinger (3):
  doc: update howto-index.sh for .adoc extensions
  contrib/contacts: rename .txt to .adoc
  contrib/subtree: rename .txt to .adoc

 Documentation/howto/howto-index.sh                 | 14 +++++++-------
 contrib/contacts/Makefile                          |  2 +-
 .../{git-contacts.txt => git-contacts.adoc}        |  0
 contrib/subtree/Makefile                           |  2 +-
 .../subtree/{git-subtree.txt => git-subtree.adoc}  |  0
 5 files changed, 9 insertions(+), 9 deletions(-)
 rename contrib/contacts/{git-contacts.txt => git-contacts.adoc} (100%)
 rename contrib/subtree/{git-subtree.txt => git-subtree.adoc} (100%)

Comments

Junio C Hamano Feb. 28, 2025, 1:45 p.m. UTC | #1

Todd Zullinger <[e-mail]> writes:

> I noticed broken links in the howto-index.html output of v2.49.0-rc0.
> This is due to the recent txt -> adoc renaming.  I chose to replace the
> numerous occurences of "txt" with "adoc" in howto-index.sh for consistency
> within the script.  It could be argued that only the few instances which
> glob '*.txt' should be changed, of course.

Thanks for noticing and sending a fix.

> I also renamed the git-*.txt files in contrib/contacts and contrib/subtree
> while I was here.  The only other file in contrib which might warrant that
> treatment is contrib/mw-to-git/git-remote-mediawiki.txt.  I skipped it as
> I am not sure whether it is actively maintained anymore.  If we want to
> rename it to be consistent, that's easy enough.
>
> Todd Zullinger (3):
>   doc: update howto-index.sh for .adoc extensions
>   contrib/contacts: rename .txt to .adoc
>   contrib/subtree: rename .txt to .adoc
>
>  Documentation/howto/howto-index.sh                 | 14 +++++++-------
>  contrib/contacts/Makefile                          |  2 +-
>  .../{git-contacts.txt => git-contacts.adoc}        |  0
>  contrib/subtree/Makefile                           |  2 +-
>  .../subtree/{git-subtree.txt => git-subtree.adoc}  |  0
>  5 files changed, 9 insertions(+), 9 deletions(-)
>  rename contrib/contacts/{git-contacts.txt => git-contacts.adoc} (100%)
>  rename contrib/subtree/{git-subtree.txt => git-subtree.adoc} (100%)