Skip to contentSkip to conversation

Fix typos

PATCH In review Andrew Kreimer via GitGitGadget 5 participants 27 messages Sep 19, 2024 – Sep 20, 2024

lore
Share & tools
lore
#0 lore raw

cover Fix typos

Fix typos in documentation, comments, etc.

Andrew Kreimer (20):
config.mak.dev: fix a typo
diffcore-rename: fix typos
fsmonitor-settings: fix a typo
git-instaweb: fix a typo
git-p4: fix typos
gpg-interface: fix a typo
http: fix a typo
merge-ll: fix a typo
merge-ort: fix typos
object-file: fix a typo
pretty: fix a typo
read-cache-ll: fix a typo
rebase: fix a typo
ref-filter: fix a typo
refs: fix typos
revision: fix a typo
run-command: fix a typo
setup: fix a typo
sideband: fix a typo
upload-pack: fix a typo

 config.mak.dev       | 2 +-
 diffcore-rename.c    | 4 ++--
 fsmonitor-settings.c | 2 +-
 git-instaweb.sh      | 2 +-
 git-p4.py            | 4 ++--
 gpg-interface.c      | 2 +-
 http.c               | 2 +-
 merge-ll.c           | 2 +-
 merge-ort.c          | 4 ++--
 object-file.c        | 2 +-
 pretty.c             | 2 +-
 read-cache-ll.h      | 2 +-
 rebase.c             | 2 +-
 ref-filter.c         | 2 +-
 refs.h               | 6 +++---
 revision.h           | 2 +-
 run-command.h        | 2 +-
 setup.c              | 2 +-
 sideband.c           | 2 +-
 upload-pack.c        | 2 +-
 20 files changed, 25 insertions(+), 25 deletions(-)

base-commit: 3fb745257b30a643ee78c9a7c52ab107c82e4745
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1794%2Falgonell%2Ffix-typos-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1794/algonell/fix-typos-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/1794

Signature · 1 line
gitgitgadget
#1 lore raw

PATCH 1/20 config.mak.dev: fix a typo

From: Andrew Kreimer <[email protected]>

Fix a typo in comments.

---
 config.mak.dev | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
config.mak.dev +1 -1
index 50026d1e0e8..8eca7fa2282 100644
@@ -69,7 +69,7 @@ DEVELOPER_CFLAGS += -Wno-missing-braces
 endif
 endif
 
-# Old versions of clang complain about initializaing a
+# Old versions of clang complain about initializing a
 # struct-within-a-struct using just "{0}" rather than "{{0}}".  This
 # error is considered a false-positive and not worth fixing, because
 # new clang versions do not, so just disable it.
Signature · 1 line
gitgitgadget
#2 lore raw

PATCH 2/20 diffcore-rename: fix typos

In reply to Andrew Kreimer via GitGitGadget

From: Andrew Kreimer <[email protected]>

Fix typos in comments.

---
 diffcore-rename.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
diffcore-rename.c +2 -2
index fab45b10d7e..3d6826baa3a 100644
@@ -933,7 +933,7 @@ static int find_basename_matches(struct diff_options *options,
 	 * spend more cycles to find similarities between files, so it may
 	 * be less likely that this heuristic is wanted.  If someone is
 	 * doing break detection, that means they do not want filename
-	 * similarity to imply any form of content similiarity, and thus
+	 * similarity to imply any form of content similarity, and thus
 	 * this heuristic would definitely be incompatible.
 	 */
 
@@ -1534,7 +1534,7 @@ void diffcore_rename_extended(struct diff_options *options,
 		 *   - remove ones not found in relevant_sources
 		 * and
 		 *   - remove ones in relevant_sources which are needed only
-		 *     for directory renames IF no ancestory directory
+		 *     for directory renames IF no ancestry directory
 		 *     actually needs to know any more individual path
 		 *     renames under them
 		 */
Signature · 1 line
gitgitgadget
#3 lore raw

PATCH 3/20 fsmonitor-settings: fix a typo

In reply to Andrew Kreimer via GitGitGadget

From: Andrew Kreimer <[email protected]>

Fix a typo in comments.

---
 fsmonitor-settings.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
fsmonitor-settings.c +1 -1
index e818583420a..a6587a8972b 100644
@@ -7,7 +7,7 @@
 #include "fsmonitor-path-utils.h"
 
 /*
- * We keep this structure defintion private and have getters
+ * We keep this structure definition private and have getters
  * for all fields so that we can lazy load it as needed.
  */
 struct fsmonitor_settings {
Signature · 1 line
gitgitgadget
#4 lore raw

PATCH 4/20 git-instaweb: fix a typo

In reply to Andrew Kreimer via GitGitGadget

From: Andrew Kreimer <[email protected]>

Fix a typo in comments.

---
 git-instaweb.sh | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
git-instaweb.sh +1 -1
index 994431c8872..8dbe21d5887 100755
@@ -612,7 +612,7 @@ python_conf() {
 	ln -sf "$root/static" "$fqgitdir/gitweb/$httpd_only/"
 
 	# generate a standalone 'python http.server' script in $fqgitdir/gitweb
-	# This asumes that python is in user's $PATH
+	# This assumes that python is in user's $PATH
 	# This script is Python 2 and 3 compatible
 	cat > "$fqgitdir/gitweb/gitweb.py" <<EOF
 #!/usr/bin/env python
Signature · 1 line
gitgitgadget
#5 lore raw

PATCH 5/20 git-p4: fix typos

In reply to Andrew Kreimer via GitGitGadget

From: Andrew Kreimer <[email protected]>

Fix typos in comments.

---
 git-p4.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
git-p4.py +2 -2
index f1ab31d5403..c0ca7becaf4 100755
@@ -54,7 +54,7 @@ import time
 import zipfile
 import zlib
 
-# On python2.7 where raw_input() and input() are both availble,
+# On python2.7 where raw_input() and input() are both available,
 # we want raw_input's semantics, but aliased to input for python3
 # compatibility
 # support basestring in python3
@@ -1804,7 +1804,7 @@ class P4Submit(Command, P4UserMap):
     status from the script will abort the process.
 
     The purpose of the hook is to edit the message file in place, and it is not
-    supressed by the `--no-verify` option. This hook is called even if
+    suppressed by the `--no-verify` option. This hook is called even if
     `--prepare-p4-only` is set.
 
     The `p4-changelist` hook is executed after the changelist message has been
Signature · 1 line
gitgitgadget
#6 lore raw

PATCH 6/20 gpg-interface: fix a typo

In reply to Andrew Kreimer via GitGitGadget

From: Andrew Kreimer <[email protected]>

Fix a typo in comments.

---
 gpg-interface.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
gpg-interface.c +1 -1
index 6587085cd19..cf4a72692d9 100644
@@ -400,7 +400,7 @@ static void parse_ssh_output(struct signature_check *sigc)
 	 * Note that "PRINCIPAL" can contain whitespace, "RSA" and
 	 * "SHA256" part could be a different token that names of
 	 * the algorithms used, and "FINGERPRINT" is a hexadecimal
-	 * string.  By finding the last occurence of " with ", we can
+	 * string.  By finding the last occurrence of " with ", we can
 	 * reliably parse out the PRINCIPAL.
 	 */
 	sigc->result = 'B';
Signature · 1 line
gitgitgadget
#7 lore raw

PATCH 7/20 http: fix a typo

In reply to Andrew Kreimer via GitGitGadget

From: Andrew Kreimer <[email protected]>

Fix a typo in comments.

---
 http.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
http.c +1 -1
index 6c6cc5c822a..376af88c5dc 100644
@@ -1707,7 +1707,7 @@ void run_active_slot(struct active_request_slot *slot)
 	 * The value of slot->finished we set before the loop was used
 	 * to set our "finished" variable when our request completed.
 	 *
-	 * 1. The slot may not have been reused for another requst
+	 * 1. The slot may not have been reused for another request
 	 *    yet, in which case it still has &finished.
 	 *
 	 * 2. The slot may already be in-use to serve another request,
Signature · 1 line
gitgitgadget
#8 lore raw

PATCH 8/20 merge-ll: fix a typo

In reply to Andrew Kreimer via GitGitGadget

From: Andrew Kreimer <[email protected]>

Fix a typo in comments.

---
 merge-ll.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
merge-ll.c +1 -1
index badb6dea57c..8e63071922b 100644
@@ -334,7 +334,7 @@ static int read_merge_config(const char *var, const char *value,
 		 *    %X - the revision for our version
 		 *    %Y - the revision for their version
 		 *
-		 * If the file is not named indentically in all versions, then each
+		 * If the file is not named identically in all versions, then each
 		 * revision is joined with the corresponding path, separated by a colon.
 		 * The external merge driver should write the results in the
 		 * file named by %A, and signal that it has done with zero exit
Signature · 1 line
gitgitgadget
#9 lore raw

PATCH 9/20 merge-ort: fix typos

In reply to Andrew Kreimer via GitGitGadget

From: Andrew Kreimer <[email protected]>

Fix typos in comments.

---
 merge-ort.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
merge-ort.c +2 -2
index 3752c7e595d..3460d14172c 100644
@@ -1147,7 +1147,7 @@ static void collect_rename_info(struct merge_options *opt,
 	 * Update dir_rename_mask (determines ignore-rename-source validity)
 	 *
 	 * dir_rename_mask helps us keep track of when directory rename
-	 * detection may be relevant.  Basically, whenver a directory is
+	 * detection may be relevant.  Basically, whenever a directory is
 	 * removed on one side of history, and a file is added to that
 	 * directory on the other side of history, directory rename
 	 * detection is relevant (meaning we have to detect renames for all
@@ -3835,7 +3835,7 @@ static int write_completed_directory(struct merge_options *opt,
 	 *     	   src/moduleB  2
 	 *
 	 *     which is used to know that xtract.c & token.txt are from the
-	 *     toplevel dirctory, while umm.c & stuff.h & baz.c are from the
+	 *     toplevel directory, while umm.c & stuff.h & baz.c are from the
 	 *     src/moduleB directory.  Again, following the example above,
 	 *     once we need to process src/moduleB, then info->offsets is
 	 *     updated to
Signature · 1 line
gitgitgadget
#10 lore raw

PATCH 10/20 object-file: fix a typo

In reply to Andrew Kreimer via GitGitGadget

From: Andrew Kreimer <[email protected]>

Fix a typo in comments.

---
 object-file.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
object-file.c +1 -1
index c5994202ba0..21266429817 100644
@@ -2275,7 +2275,7 @@ int stream_loose_object(struct input_stream *in_stream, size_t len,
 
 	/*
 	 * Common steps for write_loose_object and stream_loose_object to
-	 * end writing loose oject:
+	 * end writing loose object:
 	 *
 	 *  - End the compression of zlib stream.
 	 *  - Get the calculated oid.
Signature · 1 line
gitgitgadget
#11 lore raw

PATCH 11/20 pretty: fix a typo

In reply to Andrew Kreimer via GitGitGadget

From: Andrew Kreimer <[email protected]>

Fix a typo in comments.

---
 pretty.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
pretty.c +1 -1
index 5e5ae452530..6403e268900 100644
@@ -2205,7 +2205,7 @@ static void strbuf_add_tabexpand(struct strbuf *sb, struct grep_opt *opt,
 }
 
 /*
- * pp_handle_indent() prints out the intendation, and
+ * pp_handle_indent() prints out the indentation, and
  * the whole line (without the final newline), after
  * de-tabifying.
  */
Signature · 1 line
gitgitgadget
#12 lore raw

PATCH 12/20 read-cache-ll: fix a typo

In reply to Andrew Kreimer via GitGitGadget

From: Andrew Kreimer <[email protected]>

Fix a typo in comments.

---
 read-cache-ll.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
read-cache-ll.h +1 -1
index e0e39607ef3..b5d11d07a86 100644
@@ -151,7 +151,7 @@ enum sparse_index_mode {
 
 	/*
 	 * The index has already been collapsed to sparse directories
-	 * whereever possible.
+	 * wherever possible.
 	 */
 	INDEX_COLLAPSED,
 
Signature · 1 line
gitgitgadget
#13 lore raw

PATCH 13/20 rebase: fix a typo

In reply to Andrew Kreimer via GitGitGadget

From: Andrew Kreimer <[email protected]>

Fix a typo in comments.

---
 rebase.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
rebase.c +1 -1
index 69a1822da34..9d1ae95978e 100644
@@ -11,7 +11,7 @@
  * The callers that care if (any) rebase is requested should say
  *   if (REBASE_TRUE <= rebase_parse_value(string))
  *
- * The callers that want to differenciate an unrecognised value and
+ * The callers that want to differentiate an unrecognised value and
  * false can do so by treating _INVALID and _FALSE differently.
  */
 enum rebase_type rebase_parse_value(const char *value)
Signature · 1 line
gitgitgadget
#14 lore raw

PATCH 14/20 ref-filter: fix a typo

In reply to Andrew Kreimer via GitGitGadget

From: Andrew Kreimer <[email protected]>

Fix a typo in comments.

---
 ref-filter.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
ref-filter.c +1 -1
index b06e18a569a..308097e740b 100644
@@ -2384,7 +2384,7 @@ static int populate_value(struct ref_array_item *ref, struct strbuf *err)
 	CALLOC_ARRAY(ref->value, used_atom_cnt);
 
 	/**
-	 * NEEDSWORK: The following code might be unncessary if all codepaths
+	 * NEEDSWORK: The following code might be unnecessary if all codepaths
 	 * that call populate_value() populates the symref member of ref_array_item
 	 * like in apply_ref_filter(). Currently pretty_print_ref() is the only codepath
 	 * that calls populate_value() without first populating symref.
Signature · 1 line
gitgitgadget
#15 lore raw

PATCH 15/20 refs: fix typos

In reply to Andrew Kreimer via GitGitGadget

From: Andrew Kreimer <[email protected]>

Fix typos in comments.

---
 refs.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
refs.h +3 -3
index f8b919a1388..6d06098f8f4 100644
@@ -16,7 +16,7 @@ enum ref_storage_format ref_storage_format_by_name(const char *name);
 const char *ref_storage_format_to_name(enum ref_storage_format ref_storage_format);
 
 /*
- * Resolve a reference, recursively following symbolic refererences.
+ * Resolve a reference, recursively following symbolic references.
  *
  * Return the name of the non-symbolic reference that ultimately pointed
  * at the resolved object name.  The return value, if not NULL, is a
@@ -488,7 +488,7 @@ int refs_delete_reflog(struct ref_store *refs, const char *refname);
  * from UTC.  Its absolute value is formed by multiplying the hour
  * part by 100 and adding the minute part.  For example, 1 hour ahead
  * of UTC, CET == "+0100", is represented as positive one hundred (not
- * postiive sixty).
+ * positive sixty).
  *
  * The msg parameter is a single complete line; a reflog message given
  * to refs_delete_ref, refs_update_ref, etc. is returned to the
@@ -986,7 +986,7 @@ struct ref_store *get_worktree_ref_store(const struct worktree *wt);
 
 /*
  * Some of the names specified by refs have special meaning to Git.
- * Organize these namespaces in a comon 'ref_namespace' array for
+ * Organize these namespaces in a common 'ref_namespace' array for
  * reference from multiple places in the codebase.
  */
 
Signature · 1 line
gitgitgadget
#16 lore raw

PATCH 16/20 revision: fix a typo

In reply to Andrew Kreimer via GitGitGadget

From: Andrew Kreimer <[email protected]>

Fix a typo in comments.

---
 revision.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
revision.h +1 -1
index 0e470d1df19..71e984c452b 100644
@@ -549,7 +549,7 @@ int rewrite_parents(struct rev_info *revs,
  * The log machinery saves the original parent list so that
  * get_saved_parents() can later tell what the real parents of the
  * commits are, when commit->parents has been modified by history
- * simpification.
+ * simplification.
  *
  * get_saved_parents() will transparently return commit->parents if
  * history simplification is off.
Signature · 1 line
gitgitgadget
#17 lore raw

PATCH 17/20 run-command: fix a typo

In reply to Andrew Kreimer via GitGitGadget

From: Andrew Kreimer <[email protected]>

Fix a typo in comments.

---
 run-command.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
run-command.h +1 -1
index 03e7222d8b5..0df25e445f0 100644
@@ -535,7 +535,7 @@ enum start_bg_result {
 	/* timeout expired waiting for child to become "ready" */
 	SBGR_TIMEOUT,
 
-	/* child process exited or was signalled before becomming "ready" */
+	/* child process exited or was signalled before becoming "ready" */
 	SBGR_DIED,
 };
 
Signature · 1 line
gitgitgadget
#18 lore raw

PATCH 18/20 setup: fix a typo

In reply to Andrew Kreimer via GitGitGadget

From: Andrew Kreimer <[email protected]>

Fix a typo in comments.

---
 setup.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
setup.c +1 -1
index 29f86739212..b7084f03126 100644
@@ -518,7 +518,7 @@ static void setup_original_cwd(void)
 	 * directory we inherited from our parent process, which is a
 	 * directory we want to avoid removing.
 	 *
-	 * For convience, we would like to have the path relative to the
+	 * For convenience, we would like to have the path relative to the
 	 * worktree instead of an absolute path.
 	 *
 	 * Yes, startup_info->original_cwd is usually the same as 'prefix',
Signature · 1 line
gitgitgadget
#19 lore raw

PATCH 19/20 sideband: fix a typo

In reply to Andrew Kreimer via GitGitGadget

From: Andrew Kreimer <[email protected]>

Fix a typo in comments.

---
 sideband.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
sideband.c +1 -1
index 4e816be4e92..02805573fab 100644
@@ -191,7 +191,7 @@ int demultiplex_sideband(const char *me, int status,
 			int linelen = brk - b;
 
 			/*
-			 * For message accross packet boundary, there would have
+			 * For message across packet boundary, there would have
 			 * a nonempty "scratch" buffer from last call of this
 			 * function, and there may have a leading CR/LF in "buf".
 			 * For this case we should add a clear-to-eol suffix to
Signature · 1 line
gitgitgadget
#20 lore raw

PATCH 20/20 upload-pack: fix a typo

In reply to Andrew Kreimer via GitGitGadget

From: Andrew Kreimer <[email protected]>

Fix a typo in comments.

---
 upload-pack.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
upload-pack.c +1 -1
index f03ba3e98be..143bdffa4a8 100644
@@ -1802,7 +1802,7 @@ int upload_pack_v2(struct repository *r, struct packet_reader *request)
 			} else {
 				/*
 				 * Request had 'want's but no 'have's so we can
-				 * immedietly go to construct and send a pack.
+				 * immediately go to construct and send a pack.
 				 */
 				state = FETCH_SEND_PACK;
 			}
Signature · 1 line
gitgitgadget
#22 lore raw
Quoted 9 lines · Eric Sunshine
Quoted 3 lines · Andrew Kreimer via GitGitGadget

Fix typos in documentation, comments, etc.

Andrew Kreimer (20):

Thanks. These all look fine.

Out of curiosity, did you use a tool to discover these mistakes?

Thank you all!

Sure, my secret sauce is codespell:
https://github.com/codespell-project/codespell

#24 lore raw
Quoted 5 lines · Kristoffer Haugsbakk

All of these look correct.

Maybe all of the commits could be combined into one commit with the message “treewide: fix typos”. But that wasn’t asked for last time.[1] So I dunno.

It depends. When done carefully to make sure that nothing textually conflicts with any topics in flight, a single "treewide" patch is slightly nicer. If nothing conflicts with nothing else, either format is fine. If something have nasty conflicts (e.g., a refactor moved the comment with typos far from the original location or even to a different file), individual patch form is easier to discard the ones that need to wait.

I do not know which case this 20-patch collection falls into.

Thanks.

#25 lore raw
Quoted 13 lines · Junio C Hamano
Quoted 3 lines · Kristoffer Haugsbakk

Maybe all of the commits could be combined into one commit with the message “treewide: fix typos”. But that wasn’t asked for last time.[1] So I dunno.

It depends. When done carefully to make sure that nothing textually conflicts with any topics in flight, a single "treewide" patch is slightly nicer. If nothing conflicts with nothing else, either format is fine. If something have nasty conflicts (e.g., a refactor moved the comment with typos far from the original location or even to a different file), individual patch form is easier to discard the ones that need to wait.

Quoted 1 line

I do not know which case this 20-patch collection falls into.

For what it's worth, I found the submission easier to review as separate patches because it allowed me to review a small batch, do something else for a bit, review another batch, do something else, etc., without losing my place since I deleted the ones I had already reviewed, so I knew that those remaining in my Inbox were still pending review.

#26 lore raw
Quoted 6 lines · Eric Sunshine

For what it's worth, I found the submission easier to review as separate patches because it allowed me to review a small batch, do something else for a bit, review another batch, do something else, etc., without losing my place since I deleted the ones I had already reviewed, so I knew that those remaining in my Inbox were still pending review.

It is a very good point.

FWIW, all except for one apply cleanly to both v2.46.0 and 'seen', and one fixes a typo introduced between v2.46.0 and 'master'.

Will queue.
Thanks.