undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

t/README: avoid poor-man's small caps GIT

Browse Source 
In 48a8c26c62 (Documentation: avoid poor-man's small caps GIT,
2013-01-21), the documentation was amended to spell Git's name as Git
when talking about the system as a whole. However, t/README was skipped
over when the treatment was applied.

Bring t/README into conformance with the CodingGuidelines by casing
"Git" properly.

While we're at it, fix a small typo. Change "the git internal" to "the
Git internals".

Signed-off-by: Denton Liu <liu.denton@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Denton Liu 2020-06-07 05:48:26 -04:00 committed by Junio C Hamano
parent af6b65d45e
commit 788db145c7
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
t/README
View File

@ -1,7 +1,7 @@
Core GIT Tests Core Git Tests
============== ==============
This directory holds many test scripts for core GIT tools. The This directory holds many test scripts for core Git tools. The
first part of this short document describes how to run the tests first part of this short document describes how to run the tests
and read their output. and read their output.
@ -1080,21 +1080,21 @@ Tips for Writing Tests
As with any programming projects, existing programs are the best As with any programming projects, existing programs are the best
source of the information. However, do _not_ emulate source of the information. However, do _not_ emulate
t0000-basic.sh when writing your tests. The test is special in t0000-basic.sh when writing your tests. The test is special in
that it tries to validate the very core of GIT. For example, it that it tries to validate the very core of Git. For example, it
knows that there will be 256 subdirectories under .git/objects/, knows that there will be 256 subdirectories under .git/objects/,
and it knows that the object ID of an empty tree is a certain and it knows that the object ID of an empty tree is a certain
40-byte string. This is deliberately done so in t0000-basic.sh 40-byte string. This is deliberately done so in t0000-basic.sh
because the things the very basic core test tries to achieve is because the things the very basic core test tries to achieve is
to serve as a basis for people who are changing the GIT internal to serve as a basis for people who are changing the Git internals
drastically. For these people, after making certain changes, drastically. For these people, after making certain changes,
not seeing failures from the basic test _is_ a failure. And not seeing failures from the basic test _is_ a failure. And
such drastic changes to the core GIT that even changes these such drastic changes to the core Git that even changes these
otherwise supposedly stable object IDs should be accompanied by otherwise supposedly stable object IDs should be accompanied by
an update to t0000-basic.sh. an update to t0000-basic.sh.
However, other tests that simply rely on basic parts of the core However, other tests that simply rely on basic parts of the core
GIT working properly should not have that level of intimate Git working properly should not have that level of intimate
knowledge of the core GIT internals. If all the test scripts knowledge of the core Git internals. If all the test scripts
hardcoded the object IDs like t0000-basic.sh does, that defeats hardcoded the object IDs like t0000-basic.sh does, that defeats
the purpose of t0000-basic.sh, which is to isolate that level of the purpose of t0000-basic.sh, which is to isolate that level of
validation in one place. Your test also ends up needing validation in one place. Your test also ends up needing