[PATCH 0/1] t: fix typo in test descriptions

[PATCH 0/1] t: fix typo in test descriptions

[Nathan Stocks via GitGitGadget]

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
-- 
gitgitgadget

[PATCH 1/1] t: fix typo in test descriptions

[Nathan Stocks via GitGitGadget]

From: Nathan Stocks <cleancut@github.com>

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

Signed-off-by: Nathan Stocks <cleancut@github.com>
---
 t/t3060-ls-files-with-tree.sh | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/t/t3060-ls-files-with-tree.sh b/t/t3060-ls-files-with-tree.sh
index 44f378ce41..52ed665fcd 100755
--- a/t/t3060-ls-files-with-tree.sh
+++ b/t/t3060-ls-files-with-tree.sh
@@ -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
-- 
gitgitgadget

Re: [PATCH 1/1] t: fix typo in test descriptions

[Jeff King]

On Wed, Nov 06, 2019 at 04:18:09AM +0000, Nathan Stocks via GitGitGadget wrote:

> From: Nathan Stocks <cleancut@github.com>
> 
> 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

Re: [PATCH 1/1] t: fix typo in test descriptions

[Nathan Stocks]

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

~ Nathan

On Tue, Nov 5, 2019 at 9:28 PM Jeff King <peff@peff.net> wrote:
>
> On Wed, Nov 06, 2019 at 04:18:09AM +0000, Nathan Stocks via GitGitGadget wrote:
>
> > From: Nathan Stocks <cleancut@github.com>
> >
> > 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

Re: [PATCH 1/1] t: fix typo in test descriptions

[Taylor Blau]

Hi Nathan,

On Wed, Nov 06, 2019 at 04:18:09AM +0000, Nathan Stocks via GitGitGadget wrote:
> From: Nathan Stocks <cleancut@github.com>
>
> Fix two test descriptions which stated "git -ls-files" when the actual
> command being tested was "git ls-files".
>
> Signed-off-by: Nathan Stocks <cleancut@github.com>
> ---
>  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.

  Reviewed-by: Taylor Blau <me@ttaylorr.com>

> diff --git a/t/t3060-ls-files-with-tree.sh b/t/t3060-ls-files-with-tree.sh
> index 44f378ce41..52ed665fcd 100755
> --- a/t/t3060-ls-files-with-tree.sh
> +++ b/t/t3060-ls-files-with-tree.sh
> @@ -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
> --
> gitgitgadget

Thanks,
Taylor

Re: [PATCH 1/1] t: fix typo in test descriptions

[Nathan Stocks]

On Wed, Nov 6, 2019 at 12:37 AM Taylor Blau <me@ttaylorr.com> wrote:
> 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.
>
>   Reviewed-by: Taylor Blau <me@ttaylorr.com>

Great, thanks!

~ Nathan