[PATCH 00/34] misc *.txt -> *.adoc fixes

[PATCH 00/34] misc *.txt -> *.adoc fixes

[Todd Zullinger]

As a follow-up to <Z8Ni0EyQYgD8uWJ0@teonanacatl.net>, this
series aims to fix a good number of the remaining references
to renamed *.txt files in our tree.

The first patch fixes an actual issue, where we were
skipping all the tests in t0450-txt-doc-vs-help.

Todd Zullinger (34):
  t0450: *.txt -> *.adoc fixes
  .gitattributes: more *.txt -> *.adoc updates
  doc: remove unneeded .gitattributes
  Makefile: update reference to technical/racy-git.adoc
  README: *.txt -> *.adoc fixes
  CodingGuidelines: *.txt -> *.adoc fixes
  MyFirstContribution: *.txt -> *.adoc fixes
  MyFirstObjectWalk: *.txt -> *.adoc fixes
  howto/new-command: update reference to builtin docs
  technical/partial-clone: update reference to rev-list-options.adoc
  doc: *.txt -> *.adoc fixes
  advice.h: *.txt -> *.adoc fixes
  apply.c: *.txt -> *.adoc fixes
  builtin.h: *.txt -> *.adoc fixes
  config.c: *.txt -> *.adoc fixes
  contrib/long-running-filter: *.txt -> *.adoc fixes
  diff.h: *.txt -> *.adoc fixes
  diffcore.h: *.txt -> *.adoc fixes
  fsck.h: *.txt -> *.adoc fixes
  list-objects-filter-options.h: *.txt -> *.adoc fixes
  object-name.c: *.txt -> *.adoc fixes
  parse-options.h: *.txt -> *.adoc fixes
  pseudo-merge.h: *.txt -> *.adoc fixes
  refs.h: *.txt -> *.adoc fixes
  setup.c: *.txt -> *.adoc fixes
  simple-ipc.h: *.txt -> *.adoc fixes
  t/helper/test-rot13-filter.c: *.txt -> *.adoc fixes
  t6012: *.txt -> *.adoc fixes
  t6434: *.txt -> *.adoc fixes
  trace2.h: *.txt -> *.adoc fixes
  trace2/tr2_sysenv.c: *.txt -> *.adoc fixes
  transport.h: *.txt -> *.adoc fixes
  unpack-trees.c: *.txt -> *.adoc fixes
  xdiff: *.txt -> *.adoc fixes

 .gitattributes                                |  6 +--
 Documentation/.gitattributes                  |  1 -
 Documentation/CodingGuidelines                |  4 +-
 Documentation/MyFirstContribution.adoc        | 24 ++++-----
 Documentation/MyFirstObjectWalk.adoc          | 12 ++---
 Documentation/gitattributes.adoc              |  6 +--
 Documentation/howto/new-command.adoc          |  2 +-
 Documentation/technical/api-simple-ipc.adoc   |  2 +-
 .../technical/hash-function-transition.adoc   |  2 +-
 Documentation/technical/partial-clone.adoc    |  2 +-
 Makefile                                      |  2 +-
 README.md                                     | 14 +++---
 advice.h                                      |  2 +-
 apply.c                                       |  2 +-
 builtin.h                                     |  2 +-
 config.c                                      | 16 +++---
 contrib/long-running-filter/example.pl        |  2 +-
 diff.h                                        |  2 +-
 diffcore.h                                    |  2 +-
 fsck.h                                        |  2 +-
 list-objects-filter-options.h                 |  2 +-
 object-name.c                                 |  2 +-
 parse-options.h                               |  2 +-
 pseudo-merge.h                                |  2 +-
 refs.h                                        |  2 +-
 setup.c                                       |  2 +-
 simple-ipc.h                                  |  2 +-
 t/helper/test-rot13-filter.c                  |  2 +-
 t/t0450-txt-doc-vs-help.sh                    | 50 +++++++++----------
 ...t-help-mismatches => adoc-help-mismatches} |  0
 t/t6012-rev-list-simplify.sh                  |  2 +-
 t/t6434-merge-recursive-rename-options.sh     |  2 +-
 trace2.h                                      |  2 +-
 trace2/tr2_sysenv.c                           |  2 +-
 transport.h                                   |  2 +-
 unpack-trees.c                                |  2 +-
 xdiff/xdiff.h                                 |  2 +-
 xdiff/xpatience.c                             |  2 +-
 38 files changed, 94 insertions(+), 95 deletions(-)
 delete mode 100644 Documentation/.gitattributes
 rename t/t0450/{txt-help-mismatches => adoc-help-mismatches} (100%)

-- 
2.49.0.rc0

[PATCH 01/34] t0450: *.txt -> *.adoc fixes

[Todd Zullinger]

After 1f010d6bdf (doc: use .adoc extension for AsciiDoc files,
2025-01-20), we no longer matched any files in this test.  The result is
that we did not test for mismatches in the documentation and --help
output.

Adjust the test to look at the renamed *.adoc files.

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 t/t0450-txt-doc-vs-help.sh                    | 50 +++++++++----------
 ...t-help-mismatches => adoc-help-mismatches} |  0
 2 files changed, 25 insertions(+), 25 deletions(-)
 rename t/t0450/{txt-help-mismatches => adoc-help-mismatches} (100%)

diff --git a/t/t0450-txt-doc-vs-help.sh b/t/t0450-txt-doc-vs-help.sh
index 853101b86e..2f7504ae7e 100755
--- a/t/t0450-txt-doc-vs-help.sh
+++ b/t/t0450-txt-doc-vs-help.sh
@@ -1,6 +1,6 @@
 #!/bin/sh
 
-test_description='assert (unbuilt) Documentation/*.txt and -h output
+test_description='assert (unbuilt) Documentation/*.adoc and -h output
 
 Run this with --debug to see a summary of where we still fail to make
 the two versions consistent with one another.'
@@ -11,11 +11,11 @@ test_expect_success 'setup: list of builtins' '
 	git --list-cmds=builtins >builtins
 '
 
-test_expect_success 'list of txt and help mismatches is sorted' '
-	sort -u "$TEST_DIRECTORY"/t0450/txt-help-mismatches >expect &&
-	if ! test_cmp expect "$TEST_DIRECTORY"/t0450/txt-help-mismatches
+test_expect_success 'list of adoc and help mismatches is sorted' '
+	sort -u "$TEST_DIRECTORY"/t0450/adoc-help-mismatches >expect &&
+	if ! test_cmp expect "$TEST_DIRECTORY"/t0450/adoc-help-mismatches
 	then
-		BUG "please keep the list of txt and help mismatches sorted"
+		BUG "please keep the list of adoc and help mismatches sorted"
 	fi
 '
 
@@ -40,20 +40,20 @@ help_to_synopsis () {
 	echo "$out"
 }
 
-builtin_to_txt () {
-       echo "$GIT_BUILD_DIR/Documentation/git-$1.txt"
+builtin_to_adoc () {
+       echo "$GIT_BUILD_DIR/Documentation/git-$1.adoc"
 }
 
-txt_to_synopsis () {
+adoc_to_synopsis () {
 	builtin="$1" &&
 	out_dir="out/$builtin" &&
-	out="$out_dir/txt.synopsis" &&
+	out="$out_dir/adoc.synopsis" &&
 	if test -f "$out"
 	then
 		echo "$out" &&
 		return 0
 	fi &&
-	b2t="$(builtin_to_txt "$builtin")" &&
+	b2t="$(builtin_to_adoc "$builtin")" &&
 	sed -n \
 		-E '/^\[(verse|synopsis)\]$/,/^$/ {
 			/^$/d;
@@ -109,29 +109,29 @@ do
 		fi
 	'
 
-	txt="$(builtin_to_txt "$builtin")" &&
-	preq="$(echo BUILTIN_TXT_$builtin | tr '[:lower:]-' '[:upper:]_')" &&
+	adoc="$(builtin_to_adoc "$builtin")" &&
+	preq="$(echo BUILTIN_ADOC_$builtin | tr '[:lower:]-' '[:upper:]_')" &&
 
-	if test -f "$txt"
+	if test -f "$adoc"
 	then
 		test_set_prereq "$preq"
 	fi &&
 
-	# *.txt output assertions
-	test_expect_success "$preq" "$builtin *.txt SYNOPSIS has dashed labels" '
-		check_dashed_labels "$(txt_to_synopsis "$builtin")"
+	# *.adoc output assertions
+	test_expect_success "$preq" "$builtin *.adoc SYNOPSIS has dashed labels" '
+		check_dashed_labels "$(adoc_to_synopsis "$builtin")"
 	'
 
-	# *.txt output consistency assertions
+	# *.adoc output consistency assertions
 	result=
-	if grep -q "^$builtin$" "$TEST_DIRECTORY"/t0450/txt-help-mismatches
+	if grep -q "^$builtin$" "$TEST_DIRECTORY"/t0450/adoc-help-mismatches
 	then
 		result=failure
 	else
 		result=success
 	fi &&
 	test_expect_$result "$preq" "$builtin -h output and SYNOPSIS agree" '
-		t2s="$(txt_to_synopsis "$builtin")" &&
+		t2s="$(adoc_to_synopsis "$builtin")" &&
 		if test "$builtin" = "merge-tree"
 		then
 			test_when_finished "rm -f t2s.new" &&
@@ -140,17 +140,17 @@ do
 		fi &&
 		h2s="$(help_to_synopsis "$builtin")" &&
 
-		# The *.txt and -h use different spacing for the
+		# The *.adoc and -h use different spacing for the
 		# alignment of continued usage output, normalize it.
-		align_after_nl "$builtin" <"$t2s" >txt &&
+		align_after_nl "$builtin" <"$t2s" >adoc &&
 		align_after_nl "$builtin" <"$h2s" >help &&
-		test_cmp txt help
+		test_cmp adoc help
 	'
 
-	if test_have_prereq "$preq" && test -e txt && test -e help
+	if test_have_prereq "$preq" && test -e adoc && test -e help
 	then
 		test_debug '
-			if test_cmp txt help >cmp 2>/dev/null
+			if test_cmp adoc help >cmp 2>/dev/null
 			then
 				echo "=== DONE: $builtin ==="
 			else
@@ -161,7 +161,7 @@ do
 
 		# Not in test_expect_success in case --run is being
 		# used with --debug
-		rm -f txt help tmp 2>/dev/null
+		rm -f adoc help tmp 2>/dev/null
 	fi
 done <builtins
 
diff --git a/t/t0450/txt-help-mismatches b/t/t0450/adoc-help-mismatches
similarity index 100%
rename from t/t0450/txt-help-mismatches
rename to t/t0450/adoc-help-mismatches
-- 
2.49.0.rc0

Re: [PATCH 01/34] t0450: *.txt -> *.adoc fixes

[Junio C Hamano]

Todd Zullinger <tmz@pobox.com> writes:

> After 1f010d6bdf (doc: use .adoc extension for AsciiDoc files,
> 2025-01-20), we no longer matched any files in this test.  The result is
> that we did not test for mismatches in the documentation and --help
> output.
>
> Adjust the test to look at the renamed *.adoc files.
>
> Signed-off-by: Todd Zullinger <tmz@pobox.com>
> ---
>  t/t0450-txt-doc-vs-help.sh                    | 50 +++++++++----------
>  ...t-help-mismatches => adoc-help-mismatches} |  0
>  2 files changed, 25 insertions(+), 25 deletions(-)
>  rename t/t0450/{txt-help-mismatches => adoc-help-mismatches} (100%)

Wow, good find.  This is especially bad and I am glad we caught it
before -rc1 (the hope was that all of these should have been caught
while the topic was in 'next', which was the whole point of cooking
it longer in 'next' than usual, but that plan did not really work).

> diff --git a/t/t0450-txt-doc-vs-help.sh b/t/t0450-txt-doc-vs-help.sh
> index 853101b86e..2f7504ae7e 100755
> --- a/t/t0450-txt-doc-vs-help.sh
> +++ b/t/t0450-txt-doc-vs-help.sh
> @@ -1,6 +1,6 @@
>  #!/bin/sh
>  
> -test_description='assert (unbuilt) Documentation/*.txt and -h output
> +test_description='assert (unbuilt) Documentation/*.adoc and -h output
>  
>  Run this with --debug to see a summary of where we still fail to make
>  the two versions consistent with one another.'
> @@ -11,11 +11,11 @@ test_expect_success 'setup: list of builtins' '
>  	git --list-cmds=builtins >builtins
>  '
>  
> -test_expect_success 'list of txt and help mismatches is sorted' '
> -	sort -u "$TEST_DIRECTORY"/t0450/txt-help-mismatches >expect &&
> -	if ! test_cmp expect "$TEST_DIRECTORY"/t0450/txt-help-mismatches
> +test_expect_success 'list of adoc and help mismatches is sorted' '
> +	sort -u "$TEST_DIRECTORY"/t0450/adoc-help-mismatches >expect &&
> +	if ! test_cmp expect "$TEST_DIRECTORY"/t0450/adoc-help-mismatches
>  	then
> -		BUG "please keep the list of txt and help mismatches sorted"
> +		BUG "please keep the list of adoc and help mismatches sorted"
>  	fi
>  '
>  
> @@ -40,20 +40,20 @@ help_to_synopsis () {
>  	echo "$out"
>  }
>  
> -builtin_to_txt () {
> -       echo "$GIT_BUILD_DIR/Documentation/git-$1.txt"
> +builtin_to_adoc () {
> +       echo "$GIT_BUILD_DIR/Documentation/git-$1.adoc"
>  }
>  
> -txt_to_synopsis () {
> +adoc_to_synopsis () {
>  	builtin="$1" &&
>  	out_dir="out/$builtin" &&
> -	out="$out_dir/txt.synopsis" &&
> +	out="$out_dir/adoc.synopsis" &&
>  	if test -f "$out"
>  	then
>  		echo "$out" &&
>  		return 0
>  	fi &&
> -	b2t="$(builtin_to_txt "$builtin")" &&
> +	b2t="$(builtin_to_adoc "$builtin")" &&
>  	sed -n \
>  		-E '/^\[(verse|synopsis)\]$/,/^$/ {
>  			/^$/d;
> @@ -109,29 +109,29 @@ do
>  		fi
>  	'
>  
> -	txt="$(builtin_to_txt "$builtin")" &&
> -	preq="$(echo BUILTIN_TXT_$builtin | tr '[:lower:]-' '[:upper:]_')" &&
> +	adoc="$(builtin_to_adoc "$builtin")" &&
> +	preq="$(echo BUILTIN_ADOC_$builtin | tr '[:lower:]-' '[:upper:]_')" &&
>  
> -	if test -f "$txt"
> +	if test -f "$adoc"
>  	then
>  		test_set_prereq "$preq"
>  	fi &&
>  
> -	# *.txt output assertions
> -	test_expect_success "$preq" "$builtin *.txt SYNOPSIS has dashed labels" '
> -		check_dashed_labels "$(txt_to_synopsis "$builtin")"
> +	# *.adoc output assertions
> +	test_expect_success "$preq" "$builtin *.adoc SYNOPSIS has dashed labels" '
> +		check_dashed_labels "$(adoc_to_synopsis "$builtin")"
>  	'
>  
> -	# *.txt output consistency assertions
> +	# *.adoc output consistency assertions
>  	result=
> -	if grep -q "^$builtin$" "$TEST_DIRECTORY"/t0450/txt-help-mismatches
> +	if grep -q "^$builtin$" "$TEST_DIRECTORY"/t0450/adoc-help-mismatches
>  	then
>  		result=failure
>  	else
>  		result=success
>  	fi &&
>  	test_expect_$result "$preq" "$builtin -h output and SYNOPSIS agree" '
> -		t2s="$(txt_to_synopsis "$builtin")" &&
> +		t2s="$(adoc_to_synopsis "$builtin")" &&
>  		if test "$builtin" = "merge-tree"
>  		then
>  			test_when_finished "rm -f t2s.new" &&
> @@ -140,17 +140,17 @@ do
>  		fi &&
>  		h2s="$(help_to_synopsis "$builtin")" &&
>  
> -		# The *.txt and -h use different spacing for the
> +		# The *.adoc and -h use different spacing for the
>  		# alignment of continued usage output, normalize it.
> -		align_after_nl "$builtin" <"$t2s" >txt &&
> +		align_after_nl "$builtin" <"$t2s" >adoc &&
>  		align_after_nl "$builtin" <"$h2s" >help &&
> -		test_cmp txt help
> +		test_cmp adoc help
>  	'
>  
> -	if test_have_prereq "$preq" && test -e txt && test -e help
> +	if test_have_prereq "$preq" && test -e adoc && test -e help
>  	then
>  		test_debug '
> -			if test_cmp txt help >cmp 2>/dev/null
> +			if test_cmp adoc help >cmp 2>/dev/null
>  			then
>  				echo "=== DONE: $builtin ==="
>  			else
> @@ -161,7 +161,7 @@ do
>  
>  		# Not in test_expect_success in case --run is being
>  		# used with --debug
> -		rm -f txt help tmp 2>/dev/null
> +		rm -f adoc help tmp 2>/dev/null
>  	fi
>  done <builtins
>  
> diff --git a/t/t0450/txt-help-mismatches b/t/t0450/adoc-help-mismatches
> similarity index 100%
> rename from t/t0450/txt-help-mismatches
> rename to t/t0450/adoc-help-mismatches

Re: [PATCH 01/34] t0450: *.txt -> *.adoc fixes

[Todd Zullinger]

Junio C Hamano wrote:
> Todd Zullinger <tmz@pobox.com> writes:
> 
>> After 1f010d6bdf (doc: use .adoc extension for AsciiDoc files,
>> 2025-01-20), we no longer matched any files in this test.  The result is
>> that we did not test for mismatches in the documentation and --help
>> output.
>>
>> Adjust the test to look at the renamed *.adoc files.
>>
>> Signed-off-by: Todd Zullinger <tmz@pobox.com>
>> ---
>>  t/t0450-txt-doc-vs-help.sh                    | 50 +++++++++----------
>>  ...t-help-mismatches => adoc-help-mismatches} |  0
>>  2 files changed, 25 insertions(+), 25 deletions(-)
>>  rename t/t0450/{txt-help-mismatches => adoc-help-mismatches} (100%)
> 
> Wow, good find.  This is especially bad and I am glad we caught it
> before -rc1 (the hope was that all of these should have been caught
> while the topic was in 'next', which was the whole point of cooking
> it longer in 'next' than usual, but that plan did not really work).

Indeed.  I haven't looked closely at the CI bits to see how
we might be able to improve this.  When we skip tests
unintentionally we just don't see that currently.

I have a file of patterns I expected to skip in the rpm
builds when I maintained git in Fedora.  I'd regularly run:

     grep -E '# SKIP|skipped:' build.log | grep -Evf git.skip-test-patterns

to watch for skipped tests[1].  Those often indicated that I
needed to add a new build dependency, but sometimes catch
issues like this.  We have some similar things in the CI
scripts, I think.  Maybe we could add one for this sort of
thing.

What I don't know is how many tests we skip now and how
those differ across the multiple test runs.  It might be
annoyingly variable to track what is skipped between the
multiple OS types, releases, and build options.

I don't even know if we have the same data in the build
logs.  The rpm builds I run use `prove` with verbose output.

[1] That is also how I noticed that we've been skipping all
    tests which rely on the GPG2 prereq, as I mentioned
    recently in <Z8HVkqqD054QGPIE@teonanacatl.net>.

-- 
Todd

Re: [PATCH 01/34] t0450: *.txt -> *.adoc fixes

[Junio C Hamano]

Todd Zullinger <tmz@pobox.com> writes:

> Indeed.  I haven't looked closely at the CI bits to see how
> we might be able to improve this.  When we skip tests
> unintentionally we just don't see that currently.

In any case, while the t0450 was inadvertently disabled this way, a
topic seems to have escaped to 'master' already with an inconsistent
synopsis section and help text.

Here is a fix.

--- >8 ---
Subject: [PATCH] refs: show --no-reflog in the help text

We forgot that we must keep the documentation and help text in sync.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 builtin/refs.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/builtin/refs.c b/builtin/refs.c
index c459507d51..44d592a94c 100644
--- a/builtin/refs.c
+++ b/builtin/refs.c
@@ -8,7 +8,7 @@
 #include "worktree.h"
 
 #define REFS_MIGRATE_USAGE \
-	N_("git refs migrate --ref-format=<format> [--dry-run]")
+	N_("git refs migrate --ref-format=<format> [--no-reflog] [--dry-run]")
 
 #define REFS_VERIFY_USAGE \
 	N_("git refs verify [--strict] [--verbose]")
-- 
2.49.0-rc0-191-g335411b56b

Re: [PATCH 01/34] t0450: *.txt -> *.adoc fixes

[Todd Zullinger]

Junio C Hamano wrote:
> Todd Zullinger <tmz@pobox.com> writes:
> 
>> Indeed.  I haven't looked closely at the CI bits to see how
>> we might be able to improve this.  When we skip tests
>> unintentionally we just don't see that currently.
> 
> In any case, while the t0450 was inadvertently disabled this way, a
> topic seems to have escaped to 'master' already with an inconsistent
> synopsis section and help text.
> 
> Here is a fix.

I'm glad that's already paying off; it helps prove the patch
nicely.

I wondered for a moment why I didn't catch it with any of my
test runs.  But it's simply that the rpm build tests were on
top of 2.49.0-rc0 and my local branch for this was built on
top of tz/doc-txt-to-adoc-fixes, neither of which contain
89be7d2774 (builtin/refs: add '--no-reflog' flag to drop
reflogs, 2025-02-21).

> --- >8 ---
> Subject: [PATCH] refs: show --no-reflog in the help text
> 
> We forgot that we must keep the documentation and help text in sync.
> 
> Signed-off-by: Junio C Hamano <gitster@pobox.com>
> ---
>  builtin/refs.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/builtin/refs.c b/builtin/refs.c
> index c459507d51..44d592a94c 100644
> --- a/builtin/refs.c
> +++ b/builtin/refs.c
> @@ -8,7 +8,7 @@
>  #include "worktree.h"
>  
>  #define REFS_MIGRATE_USAGE \
> -	N_("git refs migrate --ref-format=<format> [--dry-run]")
> +	N_("git refs migrate --ref-format=<format> [--no-reflog] [--dry-run]")
>  
>  #define REFS_VERIFY_USAGE \
>  	N_("git refs verify [--strict] [--verbose]")

The fix looks obviously correct. :)

-- 
Todd

[PATCH 02/34] .gitattributes: more *.txt -> *.adoc updates

[Todd Zullinger]

All Documentation files now end in .adoc.  Update the entries for
git-merge.adoc, gitk.adoc, and user-manual.adoc to properly set the
conflict-marker-size attribute.

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 .gitattributes | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/.gitattributes b/.gitattributes
index 43fa883a84..c6a0b35116 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -12,7 +12,7 @@ CODE_OF_CONDUCT.md -whitespace
 /GIT-VERSION-GEN text eol=lf
 /mergetools/* text eol=lf
 /t/oid-info/* text eol=lf
-/Documentation/git-merge.txt conflict-marker-size=32
-/Documentation/gitk.txt conflict-marker-size=32
-/Documentation/user-manual.txt conflict-marker-size=32
+/Documentation/git-merge.adoc conflict-marker-size=32
+/Documentation/gitk.adoc conflict-marker-size=32
+/Documentation/user-manual.adoc conflict-marker-size=32
 /t/t????-*.sh conflict-marker-size=32
-- 
2.49.0.rc0

[PATCH 03/34] doc: remove unneeded .gitattributes

[Todd Zullinger]

The top-level .gitattributes file contains entries for the Documentation
tree.  Documentation/.gitattributes has not been touched since it was
added in 14f9e128d3 (Define the project whitespace policy, 2008-02-10).

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 Documentation/.gitattributes | 1 -
 1 file changed, 1 deletion(-)
 delete mode 100644 Documentation/.gitattributes

diff --git a/Documentation/.gitattributes b/Documentation/.gitattributes
deleted file mode 100644
index ddb030137d..0000000000
--- a/Documentation/.gitattributes
+++ /dev/null
@@ -1 +0,0 @@
-*.txt whitespace
-- 
2.49.0.rc0

Re: [PATCH 03/34] doc: remove unneeded .gitattributes

[Junio C Hamano]

Todd Zullinger <tmz@pobox.com> writes:

> The top-level .gitattributes file contains entries for the Documentation
> tree.  Documentation/.gitattributes has not been touched since it was
> added in 14f9e128d3 (Define the project whitespace policy, 2008-02-10).

I'd explain this change a bit differently, but the end result I
agree with.  These days we no longer have any .txt file under the
Documentation/ hierarchy, so no matter what the other gitattributes
files at the upper level(s) do, this attribute definition for .txt
file would not do anything, so it makes perfect sense to lose it.

> Signed-off-by: Todd Zullinger <tmz@pobox.com>
> ---
>  Documentation/.gitattributes | 1 -
>  1 file changed, 1 deletion(-)
>  delete mode 100644 Documentation/.gitattributes
>
> diff --git a/Documentation/.gitattributes b/Documentation/.gitattributes
> deleted file mode 100644
> index ddb030137d..0000000000
> --- a/Documentation/.gitattributes
> +++ /dev/null
> @@ -1 +0,0 @@
> -*.txt whitespace

[PATCH 04/34] Makefile: update reference to technical/racy-git.adoc

[Todd Zullinger]

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 Makefile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Makefile b/Makefile
index a9b2de0692..a8012569da 100644
--- a/Makefile
+++ b/Makefile
@@ -194,7 +194,7 @@ include shared.mak
 # Linux, kernel 2.6.11 or newer is required for reliable sub-second file times
 # on file systems with exactly 1 ns or 1 s resolution. If you intend to use Git
 # on other file systems (e.g. CEPH, CIFS, NTFS, UDF), don't enable USE_NSEC. See
-# Documentation/technical/racy-git.txt for details.
+# Documentation/technical/racy-git.adoc for details.
 #
 # Define USE_ST_TIMESPEC if your "struct stat" uses "st_ctimespec" instead of
 # "st_ctim"
-- 
2.49.0.rc0

[PATCH 05/34] README: *.txt -> *.adoc fixes

[Todd Zullinger]

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 README.md | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 665ce5f5a8..d87bca1b8c 100644
--- a/README.md
+++ b/README.md
@@ -17,15 +17,15 @@ Please read the file [INSTALL][] for installation instructions.
 Many Git online resources are accessible from <https://git-scm.com/>
 including full documentation and Git related tools.
 
-See [Documentation/gittutorial.txt][] to get started, then see
-[Documentation/giteveryday.txt][] for a useful minimum set of commands, and
-`Documentation/git-<commandname>.txt` for documentation of each command.
+See [Documentation/gittutorial.adoc][] to get started, then see
+[Documentation/giteveryday.adoc][] for a useful minimum set of commands, and
+`Documentation/git-<commandname>.adoc` for documentation of each command.
 If git has been correctly installed, then the tutorial can also be
 read with `man gittutorial` or `git help tutorial`, and the
 documentation of each command with `man git-<commandname>` or `git help
 <commandname>`.
 
-CVS users may also want to read [Documentation/gitcvs-migration.txt][]
+CVS users may also want to read [Documentation/gitcvs-migration.adoc][]
 (`man gitcvs-migration` or `git help cvs-migration` if git is
 installed).
 
@@ -66,9 +66,9 @@ and the name as (depending on your mood):
  - "goddamn idiotic truckload of sh*t": when it breaks
 
 [INSTALL]: INSTALL
-[Documentation/gittutorial.txt]: Documentation/gittutorial.txt
-[Documentation/giteveryday.txt]: Documentation/giteveryday.txt
-[Documentation/gitcvs-migration.txt]: Documentation/gitcvs-migration.txt
+[Documentation/gittutorial.adoc]: Documentation/gittutorial.adoc
+[Documentation/giteveryday.adoc]: Documentation/giteveryday.adoc
+[Documentation/gitcvs-migration.adoc]: Documentation/gitcvs-migration.adoc
 [Documentation/SubmittingPatches]: Documentation/SubmittingPatches
 [Documentation/CodingGuidelines]: Documentation/CodingGuidelines
 [po/README.md]: po/README.md
-- 
2.49.0.rc0

[PATCH 06/34] CodingGuidelines: *.txt -> *.adoc fixes

[Todd Zullinger]

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 Documentation/CodingGuidelines | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index ba047ed224..a0e7041c54 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -44,7 +44,7 @@ code are expected to match the style the surrounding code already
 uses (even if it doesn't match the overall style of existing code).
 
 But if you must have a list of rules, here are some language
-specific ones. Note that Documentation/ToolsForGit.txt document
+specific ones. Note that Documentation/ToolsForGit.adoc document
 has a collection of tips to help you use some external tools
 to conform to these guidelines.
 
@@ -755,7 +755,7 @@ Externally Visible Names
 Writing Documentation:
 
  Most (if not all) of the documentation pages are written in the
- AsciiDoc format in *.txt files (e.g. Documentation/git.txt), and
+ AsciiDoc format in *.adoc files (e.g. Documentation/git.adoc), and
  processed into HTML and manpages (e.g. git.html and git.1 in the
  same directory).
 
-- 
2.49.0.rc0

[PATCH 07/34] MyFirstContribution: *.txt -> *.adoc fixes

[Todd Zullinger]

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 Documentation/MyFirstContribution.adoc | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)

diff --git a/Documentation/MyFirstContribution.adoc b/Documentation/MyFirstContribution.adoc
index e41654c00a..afcf4b46c1 100644
--- a/Documentation/MyFirstContribution.adoc
+++ b/Documentation/MyFirstContribution.adoc
@@ -21,7 +21,7 @@ This tutorial aims to summarize the following documents, but the reader may find
 useful additional context:
 
 - `Documentation/SubmittingPatches`
-- `Documentation/howto/new-command.txt`
+- `Documentation/howto/new-command.adoc`
 
 [[getting-help]]
 === Getting Help
@@ -331,7 +331,7 @@ function body:
 apply standard precedence rules. `git_config_get_string_tmp()` will look up
 a specific key ("user.name") and give you the value. There are a number of
 single-key lookup functions like this one; you can see them all (and more info
-about how to use `git_config()`) in `Documentation/technical/api-config.txt`.
+about how to use `git_config()`) in `Documentation/technical/api-config.adoc`.
 
 You should see that the name printed matches the one you see when you run:
 
@@ -461,10 +461,10 @@ $ ./bin-wrappers/git help psuh
 
 Your new command is undocumented! Let's fix that.
 
-Take a look at `Documentation/git-*.txt`. These are the manpages for the
+Take a look at `Documentation/git-*.adoc`. These are the manpages for the
 subcommands that Git knows about. You can open these up and take a look to get
 acquainted with the format, but then go ahead and make a new file
-`Documentation/git-psuh.txt`. Like with most of the documentation in the Git
+`Documentation/git-psuh.adoc`. Like with most of the documentation in the Git
 project, help pages are written with AsciiDoc (see CodingGuidelines, "Writing
 Documentation" section). Use the following template to fill out your own
 manpage:
@@ -543,7 +543,7 @@ Try and run `./bin-wrappers/git psuh -h`. Your command should crash at the end.
 That's because `-h` is a special case which your command should handle by
 printing usage.
 
-Take a look at `Documentation/technical/api-parse-options.txt`. This is a handy
+Take a look at `Documentation/technical/api-parse-options.adoc`. This is a handy
 tool for pulling out options you need to be able to handle, and it takes a
 usage string.
 
@@ -1088,14 +1088,14 @@ This gives reviewers a summary of what they're in for when reviewing your topic.
 The one generated for `psuh` from the sample implementation looks like this:
 
 ----
- Documentation/git-psuh.txt | 40 +++++++++++++++++++++
- Makefile                   |  1 +
- builtin.h                  |  1 +
- builtin/psuh.c             | 73 ++++++++++++++++++++++++++++++++++++++
- git.c                      |  1 +
- t/t9999-psuh-tutorial.sh   | 12 +++++++
+ Documentation/git-psuh.adoc | 40 +++++++++++++++++++++
+ Makefile                    |  1 +
+ builtin.h                   |  1 +
+ builtin/psuh.c              | 73 ++++++++++++++++++++++++++++++++++++++
+ git.c                       |  1 +
+ t/t9999-psuh-tutorial.sh    | 12 +++++++
  6 files changed, 128 insertions(+)
- create mode 100644 Documentation/git-psuh.txt
+ create mode 100644 Documentation/git-psuh.adoc
  create mode 100644 builtin/psuh.c
  create mode 100755 t/t9999-psuh-tutorial.sh
 ----
-- 
2.49.0.rc0

[PATCH 08/34] MyFirstObjectWalk: *.txt -> *.adoc fixes

[Todd Zullinger]

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 Documentation/MyFirstObjectWalk.adoc | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/Documentation/MyFirstObjectWalk.adoc b/Documentation/MyFirstObjectWalk.adoc
index dec8afe5b1..d6e9dfdbbe 100644
--- a/Documentation/MyFirstObjectWalk.adoc
+++ b/Documentation/MyFirstObjectWalk.adoc
@@ -15,7 +15,7 @@ revision walk is used for operations like `git log`.
 
 === Related Reading
 
-- `Documentation/user-manual.txt` under "Hacking Git" contains some coverage of
+- `Documentation/user-manual.adoc` under "Hacking Git" contains some coverage of
   the revision walker in its various incarnations.
 - `revision.h`
 - https://eagain.net/articles/git-for-computer-scientists/[Git for Computer Scientists]
@@ -112,7 +112,7 @@ $ GIT_TRACE=1 ./bin-wrappers/git walken
 ----
 
 NOTE: For a more exhaustive overview of the new command process, take a look at
-`Documentation/MyFirstContribution.txt`.
+`Documentation/MyFirstContribution.adoc`.
 
 NOTE: A reference implementation can be found at
 https://github.com/nasamuffin/git/tree/revwalk.
@@ -132,7 +132,7 @@ used to track the allocated size of the list.
 Per entry, we find:
 
 `item` is the object provided upon which to base the object walk. Items in Git
-can be blobs, trees, commits, or tags. (See `Documentation/gittutorial-2.txt`.)
+can be blobs, trees, commits, or tags. (See `Documentation/gittutorial-2.adoc`.)
 
 `name` is the object ID (OID) of the object - a hex string you may be familiar
 with from using Git to organize your source in the past. Check the tutorial
@@ -141,7 +141,7 @@ from.
 
 `whence` indicates some information about what to do with the parents of the
 specified object. We'll explore this flag more later on; take a look at
-`Documentation/revisions.txt` to get an idea of what could set the `whence`
+`Documentation/revisions.adoc` to get an idea of what could set the `whence`
 value.
 
 `flags` are used to hint the beginning of the revision walk and are the first
@@ -153,7 +153,7 @@ can be used during the walk, as well.
 
 This one is quite a bit longer, and many fields are only used during the walk
 by `revision.c` - not configuration options. Most of the configurable flags in
-`struct rev_info` have a mirror in `Documentation/rev-list-options.txt`. It's a
+`struct rev_info` have a mirror in `Documentation/rev-list-options.adoc`. It's a
 good idea to take some time and read through that document.
 
 == Basic Commit Walk
@@ -710,7 +710,7 @@ objects grows along with the Git project.
 === Adding a Filter
 
 There are a handful of filters that we can apply to the object walk laid out in
-`Documentation/rev-list-options.txt`. These filters are typically useful for
+`Documentation/rev-list-options.adoc`. These filters are typically useful for
 operations such as creating packfiles or performing a partial clone. They are
 defined in `list-objects-filter-options.h`. For the purposes of this tutorial we
 will use the "tree:1" filter, which causes the walk to omit all trees and blobs
-- 
2.49.0.rc0

[PATCH 09/34] howto/new-command: update reference to builtin docs

[Todd Zullinger]

Commit ec14d4ecb5 (builtin.h: take over documentation from
api-builtin.txt, 2017-08-02) deleted api-builtin.txt and moved the
contents into builtin.h.  Most of the references were fixed in
d85e9448dd (new-command.txt: update reference to builtin docs,
2023-02-04), but one remained.  Fix it.

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 Documentation/howto/new-command.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/howto/new-command.adoc b/Documentation/howto/new-command.adoc
index 880c51112b..ac73c98be7 100644
--- a/Documentation/howto/new-command.adoc
+++ b/Documentation/howto/new-command.adoc
@@ -48,7 +48,7 @@ binary); this organization makes it easy for people reading the code
 to find things.
 
 See the CodingGuidelines document for other guidance on what we consider
-good practice in C and shell, and api-builtin.txt for the support
+good practice in C and shell, and builtin.h for the support
 functions available to built-in commands written in C.
 
 What every extension command needs
-- 
2.49.0.rc0

Re: [PATCH 09/34] howto/new-command: update reference to builtin docs

[Junio C Hamano]

Todd Zullinger <tmz@pobox.com> writes:

> Commit ec14d4ecb5 (builtin.h: take over documentation from
> api-builtin.txt, 2017-08-02) deleted api-builtin.txt and moved the
> contents into builtin.h.  Most of the references were fixed in
> d85e9448dd (new-command.txt: update reference to builtin docs,
> 2023-02-04), but one remained.  Fix it.
>
> Signed-off-by: Todd Zullinger <tmz@pobox.com>
> ---
>  Documentation/howto/new-command.adoc | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

;-)  This is orthogonal to the txt-to-adoc gotcha but is a long
overdue fix to even older breakage.  Thanks for addressing it.

> diff --git a/Documentation/howto/new-command.adoc b/Documentation/howto/new-command.adoc
> index 880c51112b..ac73c98be7 100644
> --- a/Documentation/howto/new-command.adoc
> +++ b/Documentation/howto/new-command.adoc
> @@ -48,7 +48,7 @@ binary); this organization makes it easy for people reading the code
>  to find things.
>  
>  See the CodingGuidelines document for other guidance on what we consider
> -good practice in C and shell, and api-builtin.txt for the support
> +good practice in C and shell, and builtin.h for the support
>  functions available to built-in commands written in C.
>  
>  What every extension command needs

[PATCH 10/34] technical/partial-clone: update reference to rev-list-options.adoc

[Todd Zullinger]

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 Documentation/technical/partial-clone.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/technical/partial-clone.adoc b/Documentation/technical/partial-clone.adoc
index bf5ec5c82d..e513e391ea 100644
--- a/Documentation/technical/partial-clone.adoc
+++ b/Documentation/technical/partial-clone.adoc
@@ -85,7 +85,7 @@ See "filter" in linkgit:gitprotocol-pack[5].
   server to request filtering during packfile construction.
 +
 There are various filters available to accommodate different situations.
-See "--filter=<filter-spec>" in Documentation/rev-list-options.txt.
+See "--filter=<filter-spec>" in Documentation/rev-list-options.adoc.
 
 - On the server pack-objects applies the requested filter-spec as it
   creates "filtered" packfiles for the client.
-- 
2.49.0.rc0

[PATCH 11/34] doc: *.txt -> *.adoc fixes

[Todd Zullinger]

Update a few more instances of Documentation/*.txt files which have been
renamed to *.adoc.

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 Documentation/gitattributes.adoc                      | 6 +++---
 Documentation/technical/api-simple-ipc.adoc           | 2 +-
 Documentation/technical/hash-function-transition.adoc | 2 +-
 3 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/Documentation/gitattributes.adoc b/Documentation/gitattributes.adoc
index 7eaca89972..a22d1ef1e1 100644
--- a/Documentation/gitattributes.adoc
+++ b/Documentation/gitattributes.adoc
@@ -513,7 +513,7 @@ If the filter command (a string value) is defined via
 `filter.<driver>.process` then Git can process all blobs with a
 single filter invocation for the entire life of a single Git
 command. This is achieved by using the long-running process protocol
-(described in technical/long-running-process-protocol.txt).
+(described in Documentation/technical/long-running-process-protocol.adoc).
 
 When Git encounters the first file that needs to be cleaned or smudged,
 it starts the filter and performs the handshake. In the handshake, the
@@ -1177,11 +1177,11 @@ integer has a meaningful effect.
 
 For example, this line in `.gitattributes` can be used to tell the merge
 machinery to leave much longer (instead of the usual 7-character-long)
-conflict markers when merging the file `Documentation/git-merge.txt`
+conflict markers when merging the file `Documentation/git-merge.adoc`
 results in a conflict.
 
 ------------------------
-Documentation/git-merge.txt	conflict-marker-size=32
+Documentation/git-merge.adoc	conflict-marker-size=32
 ------------------------
 
 
diff --git a/Documentation/technical/api-simple-ipc.adoc b/Documentation/technical/api-simple-ipc.adoc
index c4fb152b23..972178b042 100644
--- a/Documentation/technical/api-simple-ipc.adoc
+++ b/Documentation/technical/api-simple-ipc.adoc
@@ -36,7 +36,7 @@ Comparison with sub-process model
 ---------------------------------
 
 The Simple-IPC mechanism differs from the existing `sub-process.c`
-model (Documentation/technical/long-running-process-protocol.txt) and
+model (Documentation/technical/long-running-process-protocol.adoc) and
 used by applications like Git-LFS.  In the LFS-style sub-process model,
 the helper is started by the foreground process, communication happens
 via a pair of file descriptors bound to the stdin/stdout of the
diff --git a/Documentation/technical/hash-function-transition.adoc b/Documentation/technical/hash-function-transition.adoc
index 7102c7c8f5..f047fd80ca 100644
--- a/Documentation/technical/hash-function-transition.adoc
+++ b/Documentation/technical/hash-function-transition.adoc
@@ -394,7 +394,7 @@ inflated again in step 3, for a total of two inflations.
 
 Step 4 is probably necessary for good read-time performance. "git
 pack-objects" on the server optimizes the pack file for good data
-locality (see Documentation/technical/pack-heuristics.txt).
+locality (see Documentation/technical/pack-heuristics.adoc).
 
 Details of this process are likely to change. It will take some
 experimenting to get this to perform well.
-- 
2.49.0.rc0

[PATCH 12/34] advice.h: *.txt -> *.adoc fixes

[Todd Zullinger]

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 advice.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/advice.h b/advice.h
index cf2284ec43..d233cfc693 100644
--- a/advice.h
+++ b/advice.h
@@ -7,7 +7,7 @@ struct string_list;
  * To add a new advice, you need to:
  * Define a new advice_type.
  * Add a new entry to advice_setting array.
- * Add the new config variable to Documentation/config/advice.txt.
+ * Add the new config variable to Documentation/config/advice.adoc.
  * Call advise_if_enabled to print your advice.
  */
 enum advice_type {
-- 
2.49.0.rc0

[PATCH 13/34] apply.c: *.txt -> *.adoc fixes

[Todd Zullinger]

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 apply.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/apply.c b/apply.c
index b124678b93..f274a37948 100644
--- a/apply.c
+++ b/apply.c
@@ -82,7 +82,7 @@ static int parse_whitespace_option(struct apply_state *state, const char *option
 	}
 	/*
 	 * Please update $__git_whitespacelist in git-completion.bash,
-	 * Documentation/git-apply.txt, and Documentation/git-am.txt
+	 * Documentation/git-apply.adoc, and Documentation/git-am.adoc
 	 * when you add new options.
 	 */
 	return error(_("unrecognized whitespace option '%s'"), option);
-- 
2.49.0.rc0

[PATCH 14/34] builtin.h: *.txt -> *.adoc fixes

[Todd Zullinger]

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 builtin.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/builtin.h b/builtin.h
index 89928ccf92..993a583872 100644
--- a/builtin.h
+++ b/builtin.h
@@ -63,7 +63,7 @@
  *
  * . Add tests to `t/` directory.
  *
- * . Write documentation in `Documentation/git-foo.txt`.
+ * . Write documentation in `Documentation/git-foo.adoc`.
  *
  * . Add an entry for `git-foo` to `command-list.txt`.
  *
-- 
2.49.0.rc0

[PATCH 15/34] config.c: *.txt -> *.adoc fixes

[Todd Zullinger]

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 config.c | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/config.c b/config.c
index 36f76fafe5..dcb5cb5265 100644
--- a/config.c
+++ b/config.c
@@ -1652,7 +1652,7 @@ static int git_default_core_config(const char *var, const char *value,
 		return 0;
 	}
 
-	/* Add other config variables here and to Documentation/config.txt. */
+	/* Add other config variables here and to Documentation/config.adoc. */
 	return platform_core_config(var, value, ctx, cb);
 }
 
@@ -1663,7 +1663,7 @@ static int git_default_sparse_config(const char *var, const char *value)
 		return 0;
 	}
 
-	/* Add other config variables here and to Documentation/config/sparse.txt. */
+	/* Add other config variables here and to Documentation/config/sparse.adoc. */
 	return 0;
 }
 
@@ -1679,7 +1679,7 @@ static int git_default_i18n_config(const char *var, const char *value)
 		return git_config_string(&git_log_output_encoding, var, value);
 	}
 
-	/* Add other config variables here and to Documentation/config.txt. */
+	/* Add other config variables here and to Documentation/config.adoc. */
 	return 0;
 }
 
@@ -1715,7 +1715,7 @@ static int git_default_branch_config(const char *var, const char *value)
 		return 0;
 	}
 
-	/* Add other config variables here and to Documentation/config.txt. */
+	/* Add other config variables here and to Documentation/config.adoc. */
 	return 0;
 }
 
@@ -1744,7 +1744,7 @@ static int git_default_push_config(const char *var, const char *value)
 		return 0;
 	}
 
-	/* Add other config variables here and to Documentation/config.txt. */
+	/* Add other config variables here and to Documentation/config.adoc. */
 	return 0;
 }
 
@@ -1760,7 +1760,7 @@ static int git_default_mailmap_config(const char *var, const char *value)
 		return git_config_string(&git_mailmap_blob, var, value);
 	}
 
-	/* Add other config variables here and to Documentation/config.txt. */
+	/* Add other config variables here and to Documentation/config.adoc. */
 	return 0;
 }
 
@@ -1773,7 +1773,7 @@ static int git_default_attr_config(const char *var, const char *value)
 
 	/*
 	 * Add other attribute related config variables here and to
-	 * Documentation/config/attr.txt.
+	 * Documentation/config/attr.adoc.
 	 */
 	return 0;
 }
@@ -1831,7 +1831,7 @@ int git_default_config(const char *var, const char *value,
 	if (starts_with(var, "sparse."))
 		return git_default_sparse_config(var, value);
 
-	/* Add other config variables here and to Documentation/config.txt. */
+	/* Add other config variables here and to Documentation/config.adoc. */
 	return 0;
 }
 
-- 
2.49.0.rc0

[PATCH 16/34] contrib/long-running-filter: *.txt -> *.adoc fixes

[Todd Zullinger]

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 contrib/long-running-filter/example.pl | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/contrib/long-running-filter/example.pl b/contrib/long-running-filter/example.pl
index a677569ddd..4b83e4c5e8 100755
--- a/contrib/long-running-filter/example.pl
+++ b/contrib/long-running-filter/example.pl
@@ -1,7 +1,7 @@
 #!/usr/bin/perl
 #
 # Example implementation for the Git filter protocol version 2
-# See Documentation/gitattributes.txt, section "Filter Protocol"
+# See Documentation/gitattributes.adoc, section "Filter Protocol"
 #
 # Please note, this pass-thru filter is a minimal skeleton. No proper
 # error handling was implemented.
-- 
2.49.0.rc0

[PATCH 17/34] diff.h: *.txt -> *.adoc fixes

[Todd Zullinger]

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 diff.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/diff.h b/diff.h
index 0a566f5531..ff0348e4a9 100644
--- a/diff.h
+++ b/diff.h
@@ -333,7 +333,7 @@ struct diff_options {
 	int xdl_opts;
 	int ignore_driver_algorithm;
 
-	/* see Documentation/diff-options.txt */
+	/* see Documentation/diff-options.adoc */
 	char **anchors;
 	size_t anchors_nr, anchors_alloc;
 
-- 
2.49.0.rc0

[PATCH 18/34] diffcore.h: *.txt -> *.adoc fixes

[Todd Zullinger]

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 diffcore.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/diffcore.h b/diffcore.h
index 2feb325031..9c0a0e7aaf 100644
--- a/diffcore.h
+++ b/diffcore.h
@@ -107,7 +107,7 @@ struct diff_filepair {
 	struct diff_filespec *one;
 	struct diff_filespec *two;
 	unsigned short int score;
-	char status; /* M C R A D U etc. (see Documentation/diff-format.txt or DIFF_STATUS_* in diff.h) */
+	char status; /* M C R A D U etc. (see Documentation/diff-format.adoc or DIFF_STATUS_* in diff.h) */
 	unsigned broken_pair : 1;
 	unsigned renamed_pair : 1;
 	unsigned is_unmerged : 1;
-- 
2.49.0.rc0

[PATCH 19/34] fsck.h: *.txt -> *.adoc fixes

[Todd Zullinger]

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 fsck.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/fsck.h b/fsck.h
index a44c231a5f..a95ae7eb84 100644
--- a/fsck.h
+++ b/fsck.h
@@ -15,7 +15,7 @@ enum fsck_msg_type {
 };
 
 /*
- * Documentation/fsck-msgids.txt documents these; when
+ * Documentation/fsck-msgids.adoc documents these; when
  * modifying this list in any way, make sure to keep the
  * two in sync.
  */
-- 
2.49.0.rc0

[PATCH 20/34] list-objects-filter-options.h: *.txt -> *.adoc fixes

[Todd Zullinger]

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 list-objects-filter-options.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/list-objects-filter-options.h b/list-objects-filter-options.h
index 55fab8563d..7b2108b986 100644
--- a/list-objects-filter-options.h
+++ b/list-objects-filter-options.h
@@ -82,7 +82,7 @@ void list_objects_filter_init(struct list_objects_filter_options *filter_options
  *       "filter" SP <arg>
  *
  * The filter keyword will be used by many commands.
- * See Documentation/rev-list-options.txt for allowed values for <arg>.
+ * See Documentation/rev-list-options.adoc for allowed values for <arg>.
  *
  * Capture the given arg as the "filter_spec".  This can be forwarded to
  * subordinate commands when necessary (although it's better to pass it through
-- 
2.49.0.rc0

[PATCH 21/34] object-name.c: *.txt -> *.adoc fixes

[Todd Zullinger]

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 object-name.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/object-name.c b/object-name.c
index 945d5bdef2..76749fbfe6 100644
--- a/object-name.c
+++ b/object-name.c
@@ -1273,7 +1273,7 @@ static int peel_onion(struct repository *r, const char *name, int len,
 }
 
 /*
- * Documentation/revisions.txt says:
+ * Documentation/revisions.adoc says:
  *    '<describeOutput>', e.g. 'v1.7.4.2-679-g3bee7fb'::
  *      Output from `git describe`; i.e. a closest tag, optionally
  *      followed by a dash and a number of commits, followed by a dash, a
-- 
2.49.0.rc0

[PATCH 22/34] parse-options.h: *.txt -> *.adoc fixes

[Todd Zullinger]

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 parse-options.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/parse-options.h b/parse-options.h
index fca944d9a9..997ffbee80 100644
--- a/parse-options.h
+++ b/parse-options.h
@@ -6,7 +6,7 @@
 struct repository;
 
 /**
- * Refer to Documentation/technical/api-parse-options.txt for the API doc.
+ * Refer to Documentation/technical/api-parse-options.adoc for the API doc.
  */
 
 enum parse_opt_type {
-- 
2.49.0.rc0

[PATCH 23/34] pseudo-merge.h: *.txt -> *.adoc fixes

[Todd Zullinger]

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 pseudo-merge.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/pseudo-merge.h b/pseudo-merge.h
index 29df8a32ec..c9fbe9d312 100644
--- a/pseudo-merge.h
+++ b/pseudo-merge.h
@@ -101,7 +101,7 @@ void select_pseudo_merges(struct bitmap_writer *writer);
 
 /*
  * Represents a serialized view of a file containing pseudo-merge(s)
- * (see Documentation/technical/bitmap-format.txt for a specification
+ * (see Documentation/technical/bitmap-format.adoc for a specification
  * of the format).
  */
 struct pseudo_merge_map {
-- 
2.49.0.rc0

[PATCH 24/34] refs.h: *.txt -> *.adoc fixes

[Todd Zullinger]

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 refs.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/refs.h b/refs.h
index 09be47afbe..31c67a71b2 100644
--- a/refs.h
+++ b/refs.h
@@ -577,7 +577,7 @@ int refs_for_each_reflog(struct ref_store *refs, each_reflog_fn fn, void *cb_dat
 
 /*
  * Return 0 iff refname has the correct format for a refname according
- * to the rules described in Documentation/git-check-ref-format.txt.
+ * to the rules described in Documentation/git-check-ref-format.adoc.
  * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
  * reference names.  If REFNAME_REFSPEC_PATTERN is set in flags, then
  * allow a single "*" wildcard character in the refspec. No leading or
-- 
2.49.0.rc0

[PATCH 25/34] setup.c: *.txt -> *.adoc fixes

[Todd Zullinger]

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 setup.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/setup.c b/setup.c
index 7da7aa8984..801bd8c1ee 100644
--- a/setup.c
+++ b/setup.c
@@ -1822,7 +1822,7 @@ const char *setup_git_directory_gently(int *nongit_ok)
 	 *
 	 * Regardless of the state of nongit_ok, startup_info->prefix and
 	 * the GIT_PREFIX environment variable must always match. For details
-	 * see Documentation/config/alias.txt.
+	 * see Documentation/config/alias.adoc.
 	 */
 	if (nongit_ok && *nongit_ok)
 		startup_info->have_repository = 0;
-- 
2.49.0.rc0

[PATCH 26/34] simple-ipc.h: *.txt -> *.adoc fixes

[Todd Zullinger]

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 simple-ipc.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/simple-ipc.h b/simple-ipc.h
index 3916eaf70d..701e005cb8 100644
--- a/simple-ipc.h
+++ b/simple-ipc.h
@@ -2,7 +2,7 @@
 #define GIT_SIMPLE_IPC_H
 
 /*
- * See Documentation/technical/api-simple-ipc.txt
+ * See Documentation/technical/api-simple-ipc.adoc
  */
 
 enum ipc_active_state {
-- 
2.49.0.rc0

[PATCH 27/34] t/helper/test-rot13-filter.c: *.txt -> *.adoc fixes

[Todd Zullinger]

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 t/helper/test-rot13-filter.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/t/helper/test-rot13-filter.c b/t/helper/test-rot13-filter.c
index ff407b575c..722b1cbe77 100644
--- a/t/helper/test-rot13-filter.c
+++ b/t/helper/test-rot13-filter.c
@@ -1,6 +1,6 @@
 /*
  * Example implementation for the Git filter protocol version 2
- * See Documentation/gitattributes.txt, section "Filter Protocol"
+ * See Documentation/gitattributes.adoc, section "Filter Protocol"
  *
  * Usage: test-tool rot13-filter [--always-delay] --log=<path> <capabilities>
  *
-- 
2.49.0.rc0

[PATCH 28/34] t6012: *.txt -> *.adoc fixes

[Todd Zullinger]

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 t/t6012-rev-list-simplify.sh | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/t/t6012-rev-list-simplify.sh b/t/t6012-rev-list-simplify.sh
index de1e87f162..4cecb6224c 100755
--- a/t/t6012-rev-list-simplify.sh
+++ b/t/t6012-rev-list-simplify.sh
@@ -177,7 +177,7 @@ test_expect_success '--full-diff is not affected by --parents' '
 #   \ /      /\        /
 #    `---X--'  `---Y--'
 #
-# This example is explained in Documentation/rev-list-options.txt
+# This example is explained in Documentation/rev-list-options.adoc
 
 test_expect_success 'setup rebuild repo' '
 	rm -rf .git * &&
-- 
2.49.0.rc0

[PATCH 29/34] t6434: *.txt -> *.adoc fixes

[Todd Zullinger]

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 t/t6434-merge-recursive-rename-options.sh | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/t/t6434-merge-recursive-rename-options.sh b/t/t6434-merge-recursive-rename-options.sh
index a11707835b..6e913c30a1 100755
--- a/t/t6434-merge-recursive-rename-options.sh
+++ b/t/t6434-merge-recursive-rename-options.sh
@@ -22,7 +22,7 @@ R075    2-old   2-new
 R100    3-old   3-new
 
 Actual similarity indices are parsed from diff output. We rely on the fact that
-they are rounded down (see, e.g., Documentation/diff-generate-patch.txt, which
+they are rounded down (see, e.g., Documentation/diff-generate-patch.adoc, which
 mentions this in a different context).
 '
 
-- 
2.49.0.rc0

[PATCH 30/34] trace2.h: *.txt -> *.adoc fixes

[Todd Zullinger]

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 trace2.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/trace2.h b/trace2.h
index 901f39253a..e4f23784e4 100644
--- a/trace2.h
+++ b/trace2.h
@@ -31,7 +31,7 @@
  *
  * For more info about: trace2 targets, conventions for public functions and
  * macros, trace2 target formats and examples on trace2 API usage refer to
- * Documentation/technical/api-trace2.txt
+ * Documentation/technical/api-trace2.adoc
  *
  */
 
-- 
2.49.0.rc0

[PATCH 31/34] trace2/tr2_sysenv.c: *.txt -> *.adoc fixes

[Todd Zullinger]

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 trace2/tr2_sysenv.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/trace2/tr2_sysenv.c b/trace2/tr2_sysenv.c
index 01379c5cad..4abc218514 100644
--- a/trace2/tr2_sysenv.c
+++ b/trace2/tr2_sysenv.c
@@ -7,7 +7,7 @@
 
 /*
  * Each entry represents a trace2 setting.
- * See Documentation/technical/api-trace2.txt
+ * See Documentation/technical/api-trace2.adoc
  */
 struct tr2_sysenv_entry {
 	const char *env_var_name;
-- 
2.49.0.rc0

[PATCH 32/34] transport.h: *.txt -> *.adoc fixes

[Todd Zullinger]

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 transport.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/transport.h b/transport.h
index 44100fa9b7..892f19454a 100644
--- a/transport.h
+++ b/transport.h
@@ -168,7 +168,7 @@ struct transport *transport_get(struct remote *, const char *);
  * Check whether a transport is allowed by the environment.
  *
  * Type should generally be the URL scheme, as described in
- * Documentation/git.txt
+ * Documentation/git.adoc
  *
  * from_user specifies if the transport was given by the user.  If unknown pass
  * a -1 to read from the environment to determine if the transport was given by
-- 
2.49.0.rc0

[PATCH 33/34] unpack-trees.c: *.txt -> *.adoc fixes

[Todd Zullinger]

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 unpack-trees.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/unpack-trees.c b/unpack-trees.c
index 334cb84f65..cf5b73c84b 100644
--- a/unpack-trees.c
+++ b/unpack-trees.c
@@ -2904,7 +2904,7 @@ int threeway_merge(const struct cache_entry * const *stages,
  * The rule is to "carry forward" what is in the index without losing
  * information across a "fast-forward", favoring a successful merge
  * over a merge failure when it makes sense.  For details of the
- * "carry forward" rule, please see <Documentation/git-read-tree.txt>.
+ * "carry forward" rule, please see <Documentation/git-read-tree.adoc>.
  *
  */
 int twoway_merge(const struct cache_entry * const *src,
-- 
2.49.0.rc0

[PATCH 34/34] xdiff: *.txt -> *.adoc fixes

[Todd Zullinger]

Signed-off-by: Todd Zullinger <tmz@pobox.com>
---
 xdiff/xdiff.h     | 2 +-
 xdiff/xpatience.c | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/xdiff/xdiff.h b/xdiff/xdiff.h
index bb56b23f34..2cecde5afe 100644
--- a/xdiff/xdiff.h
+++ b/xdiff/xdiff.h
@@ -85,7 +85,7 @@ typedef struct s_xpparam {
 	regex_t **ignore_regex;
 	size_t ignore_regex_nr;
 
-	/* See Documentation/diff-options.txt. */
+	/* See Documentation/diff-options.adoc. */
 	char **anchors;
 	size_t anchors_nr;
 } xpparam_t;
diff --git a/xdiff/xpatience.c b/xdiff/xpatience.c
index 82f663004e..77dc411d19 100644
--- a/xdiff/xpatience.c
+++ b/xdiff/xpatience.c
@@ -64,7 +64,7 @@ struct hashmap {
 
 		/*
 		 * If 1, this entry can serve as an anchor. See
-		 * Documentation/diff-options.txt for more information.
+		 * Documentation/diff-options.adoc for more information.
 		 */
 		unsigned anchor : 1;
 	} *entries, *first, *last;
-- 
2.49.0.rc0

Re: [PATCH 00/34] misc *.txt -> *.adoc fixes

[brian m. carlson]

[-- Attachment #1: Type: text/plain, Size: 433 bytes --]

On 2025-03-03 at 20:43:58, Todd Zullinger wrote:
> As a follow-up to <Z8Ni0EyQYgD8uWJ0@teonanacatl.net>, this
> series aims to fix a good number of the remaining references
> to renamed *.txt files in our tree.
> 
> The first patch fixes an actual issue, where we were
> skipping all the tests in t0450-txt-doc-vs-help.

All of these seem reasonable to me.
-- 
brian m. carlson (they/them or he/him)
Toronto, Ontario, CA

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 263 bytes --]

Re: [PATCH 00/34] misc *.txt -> *.adoc fixes

[Junio C Hamano]

"brian m. carlson" <sandals@crustytoothpaste.net> writes:

> On 2025-03-03 at 20:43:58, Todd Zullinger wrote:
>> As a follow-up to <Z8Ni0EyQYgD8uWJ0@teonanacatl.net>, this
>> series aims to fix a good number of the remaining references
>> to renamed *.txt files in our tree.
>> 
>> The first patch fixes an actual issue, where we were
>> skipping all the tests in t0450-txt-doc-vs-help.
>
> All of these seem reasonable to me.

Yup, I plan to merge them down before -rc1 (or -rc2 at the latest).

Thanks.