diff mbox series

[v2,1/5] correct typo/spelling error in t/README

Message ID 20180914201340.37400-2-benpeart@microsoft.com (mailing list archive)
State New, archived
Headers show
Series [v2,1/5] correct typo/spelling error in t/README | expand

Commit Message

Ben Peart Sept. 14, 2018, 8:13 p.m. UTC
Correct a spelling error in the documentation for GIT_TEST_OE_DELTA_SIZE

Signed-off-by: Ben Peart <Ben.Peart@microsoft.com>
---
 t/README | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Jonathan Nieder Sept. 14, 2018, 8:43 p.m. UTC | #1
Hi,

Ben Peart wrote:

> Subject: correct typo/spelling error in t/README

nit: what is the difference between a typo/spelling error and another
kind of spelling error?  Maybe this could be something like

	t/README: correct spelling of "uncommon"

which makes it crystal clear what the patch will do.

> Correct a spelling error in the documentation for GIT_TEST_OE_DELTA_SIZE

The commit message should consist of complete sentences, so this is
missing a period.  Alternatively, I think it would be fine to omit the
sentence altogether.

> Signed-off-by: Ben Peart <Ben.Peart@microsoft.com>
> ---
>  t/README | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

This appears to be the only usage of uncomon in the code base.  Thanks
for fixing it.

With or without the commit message tweaks mentioned above,
Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>

Thanks.
diff mbox series

Patch

diff --git a/t/README b/t/README
index 9028b47d92..56a417439c 100644
--- a/t/README
+++ b/t/README
@@ -315,7 +315,7 @@  packs on demand. This normally only happens when the object size is
 over 2GB. This variable forces the code path on any object larger than
 <n> bytes.
 
-GIT_TEST_OE_DELTA_SIZE=<n> exercises the uncomon pack-objects code
+GIT_TEST_OE_DELTA_SIZE=<n> exercises the uncommon pack-objects code
 path where deltas larger than this limit require extra memory
 allocation for bookkeeping.