@matheusbsbs / matheus-bagliano / commits / 788db145c7
Fork 0

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

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>

Denton Liu committed Jun 7, 2020 at 05:48 UTC 788db145c714a6aa4db912579df7fcd44f6e70d0
1 file changed +7 -7
t/README
+7 -7
@@ -1,7 +1,7 @@
1 -Core GIT Tests
1 +Core Git Tests
2 ==============
3
4 -This directory holds many test scripts for core GIT tools. The
4 +This directory holds many test scripts for core Git tools. The
5 first part of this short document describes how to run the tests
6 and read their output.
7
@@ -1080,21 +1080,21 @@ Tips for Writing Tests
1080 As with any programming projects, existing programs are the best
1081 source of the information. However, do _not_ emulate
1082 t0000-basic.sh when writing your tests. The test is special in
1083 -that it tries to validate the very core of GIT. For example, it
1083 +that it tries to validate the very core of Git. For example, it
1084 knows that there will be 256 subdirectories under .git/objects/,
1085 and it knows that the object ID of an empty tree is a certain
1086 40-byte string. This is deliberately done so in t0000-basic.sh
1087 because the things the very basic core test tries to achieve is
1088 -to serve as a basis for people who are changing the GIT internal
1088 +to serve as a basis for people who are changing the Git internals
1089 drastically. For these people, after making certain changes,
1090 not seeing failures from the basic test _is_ a failure. And
1091 -such drastic changes to the core GIT that even changes these
1091 +such drastic changes to the core Git that even changes these
1092 otherwise supposedly stable object IDs should be accompanied by
1093 an update to t0000-basic.sh.
1094
1095 However, other tests that simply rely on basic parts of the core
1096 -GIT working properly should not have that level of intimate
1097 -knowledge of the core GIT internals. If all the test scripts
1096 +Git working properly should not have that level of intimate
1097 +knowledge of the core Git internals. If all the test scripts
1098 hardcoded the object IDs like t0000-basic.sh does, that defeats
1099 the purpose of t0000-basic.sh, which is to isolate that level of
1100 validation in one place. Your test also ends up needing