Skip to contentSkip to conversation

t: fix typo in test descriptions

PATCH In review Nathan Stocks via GitGitGadget 4 participants 6 messages Nov 6, 2019

lore
Share & tools
lore
#0 lore raw

cover t: fix typo in test descriptions

Fix two test descriptions which stated "git -ls-files" when the actual command being tested was "git ls-files".

I based this patch off of 'maint' since the typo predates the latest release, but the patch can be applied cleanly to 'master'.

I happened to run across this while running the following quick-and-dirty command to see if it looked like there were any undocumented top-level git options that were run from inside tests. The answer to that was unsurprisingly "no", but it did turn up this typo to fix!

git grep "[^./i]git -" |

    grep -v 'git -C' |
    grep -v 'git -c' |
    grep -v 'git --help' |
    grep -v 'git --exec-path' |
    grep -v 'git --version' |
    grep -v 'git --html-path' |
    grep -v 'git --man-path' |
    grep -v 'git --info-path' |
    grep -v 'git -p' |
    grep -v 'git --paginate' |
    grep -v 'git -P' |
    grep -v 'git --no-pager' |
    grep -v 'git --no-replace-objects' |
    grep -v 'git --bare' |
    grep -v 'git --git-dir' |
    grep -v 'git --work-tree' |
    grep -v 'git --namespace' |
    grep -v 'test_completion' |
    grep -v 'git-grep.*acted as if' |
    grep -v 'git --super-prefix' |
    grep -v 'git --no-replace-objects' |
    grep -v 'git --literal-pathspecs' |
    grep -v 'git --glob-pathspecs' |
    grep -v 'git --noglob-pathspecs' |
    grep -v 'git --icase-pathspecs' |
    grep -v 'git --no-optional-locks' |
    grep -v 'git --list-cmds' |
    grep -v 'git ->'

Nathan Stocks (1):
t: fix typo in test descriptions

 t/t3060-ls-files-with-tree.sh | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

base-commit: 5fa0f5238b0cd46cfe7f6fa76c3f526ea98148d9
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-448%2FCleanCut%2Ft3060-fix-description-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-448/CleanCut/t3060-fix-description-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/448

Signature · 1 line
gitgitgadget
#1 lore raw

PATCH 1/1 t: fix typo in test descriptions

From: Nathan Stocks <[email protected]>

Fix two test descriptions which stated "git -ls-files" when the actual command being tested was "git ls-files".

---
 t/t3060-ls-files-with-tree.sh | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
t/t3060-ls-files-with-tree.sh +2 -2
index 44f378ce41..52ed665fcd 100755
@@ -47,7 +47,7 @@ test_expect_success setup '
 	git add .
 '
 
-test_expect_success 'git -ls-files --with-tree should succeed from subdir' '
+test_expect_success 'git ls-files --with-tree should succeed from subdir' '
 	# We have to run from a sub-directory to trigger prune_path
 	# Then we finally get to run our --with-tree test
 	(
@@ -57,7 +57,7 @@ test_expect_success 'git -ls-files --with-tree should succeed from subdir' '
 '
 
 test_expect_success \
-    'git -ls-files --with-tree should add entries from named tree.' \
+    'git ls-files --with-tree should add entries from named tree.' \
     'test_cmp expected output'
 
 test_done
Signature · 1 line
gitgitgadget
#2 lore raw
Quoted 4 lines · Nathan Stocks via GitGitGadget

From: Nathan Stocks <[email protected]>

Fix two test descriptions which stated "git -ls-files" when the actual command being tested was "git ls-files".

Thanks, this is obviously an improvement.

I was curious if there was any backstory here. They came from 54e1abce90 (Add test case for ls-files --with-tree, 2007-10-03). That was around the time of transitioning from "git-ls-files" to "git ls-files", so maybe that caused the confusion. :)

-Peff

#3 lore raw

That would make sense. It would be easy to add a space and forget to remove the hyphen.

~ Nathan

Quoted 16 lines · Jeff King
Quoted 4 lines · Nathan Stocks via GitGitGadget

From: Nathan Stocks <[email protected]>

Fix two test descriptions which stated "git -ls-files" when the actual command being tested was "git ls-files".

Thanks, this is obviously an improvement.

I was curious if there was any backstory here. They came from 54e1abce90 (Add test case for ls-files --with-tree, 2007-10-03). That was around the time of transitioning from "git-ls-files" to "git ls-files", so maybe that caused the confusion. :)

-Peff

Reviewed-by on v1 1/1
#4 lore raw
In reply to Nathan Stocks via GitGitGadget

Hi Nathan,

Quoted 9 lines · Nathan Stocks via GitGitGadget

From: Nathan Stocks <[email protected]>

Fix two test descriptions which stated "git -ls-files" when the actual command being tested was "git ls-files".

---
 t/t3060-ls-files-with-tree.sh | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Nice find. I agree with your and Peff's conclusion about when these might have been introduced, so that they have survived so long indicates that this was an especially good find indeed.

Your patch looks great to me.

Quoted 23 lines
t/t3060-ls-files-with-tree.sh +2 -3
index 44f378ce41..52ed665fcd 100755
@@ -47,7 +47,7 @@ test_expect_success setup '
 	git add .
 '
 
-test_expect_success 'git -ls-files --with-tree should succeed from subdir' '
+test_expect_success 'git ls-files --with-tree should succeed from subdir' '
 	# We have to run from a sub-directory to trigger prune_path
 	# Then we finally get to run our --with-tree test
 	(
@@ -57,7 +57,7 @@ test_expect_success 'git -ls-files --with-tree should succeed from subdir' '
 '
 
 test_expect_success \
-    'git -ls-files --with-tree should add entries from named tree.' \
+    'git ls-files --with-tree should add entries from named tree.' \
     'test_cmp expected output'
 
 test_done
--
Quoted 1 line

gitgitgadget

Thanks,
Taylor

#5 lore raw
Quoted 7 lines · Taylor Blau

Nice find. I agree with your and Peff's conclusion about when these might have been introduced, so that they have survived so long indicates that this was an especially good find indeed.

Your patch looks great to me.

Great, thanks!

~ Nathan