Skip to contentSkip to conversation

Other doc fixes

PATCH In review Elijah Newren via GitGitGadget 3 participants 6 messages Nov 5, 2019 – Nov 7, 2019 Documentation

lore
Share & tools
lore

Elijah Newren via GitGitGadget

author
#0 lore raw

cover Other doc fixes

In addition to the pile of spelling fixes in my other pull request, here are some simple documentation fixes other than spelling errors (remove repeated word, '.' vs '->', missing hyphen).

Elijah Newren (3):
git-filter-branch.txt: correct argument name typo
hashmap: fix documentation misuses of -> versus . name-hash.c: remove duplicate word in comment

 Documentation/git-filter-branch.txt | 2 +-
 hashmap.h                           | 6 +++---
 name-hash.c                         | 2 +-
 3 files changed, 5 insertions(+), 5 deletions(-)

base-commit: da72936f544fec5a335e66432610e4cef4430991
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-454%2Fnewren%2Fother-doc-fixes-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-454/newren/other-doc-fixes-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/454

Signature · 1 line
gitgitgadget
author
#1 lore raw

PATCH 1/3 git-filter-branch.txt: correct argument name typo

From: Elijah Newren <[email protected]>

Signed-off-by Elijah Newren <[email protected]>
---
 Documentation/git-filter-branch.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/git-filter-branch.txt +1 -1
index 5876598852..1ba4667b12 100644
@@ -649,7 +649,7 @@ create hoards of confusing empty commits
 commits from before the filtering operation are also pruned instead of
 just pruning commits that became empty due to filtering rules.
 
-* If --prune empty is specified, sometimes empty commits are missed
+* If --prune-empty is specified, sometimes empty commits are missed
 and left around anyway (a somewhat rare bug, but it happens...)
 
 * A minor issue, but users who have a goal to update all names and
Signature · 1 line
gitgitgadget
author
#3 lore raw

PATCH 3/3 name-hash.c: remove duplicate word in comment

In reply to Elijah Newren via GitGitGadget

From: Elijah Newren <[email protected]>

Signed-off-by Elijah Newren <[email protected]>
---
 name-hash.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
name-hash.c +1 -1
index ceb1d7bd6f..4885bae5da 100644
@@ -218,7 +218,7 @@ static int lookup_lazy_params(struct index_state *istate)
  * However, the hashmap is going to put items into bucket
  * chains based on their hash values.  Use that to create n
  * mutexes and lock on mutex[bucket(hash) % n].  This will
- * decrease the collision rate by (hopefully) by a factor of n.
+ * decrease the collision rate by (hopefully) a factor of n.
  */
 static void init_dir_mutex(void)
 {
Signature · 1 line
gitgitgadget
author
#2 lore raw

PATCH 2/3 hashmap: fix documentation misuses of -> versus .

In reply to Elijah Newren via GitGitGadget

From: Elijah Newren <[email protected]>

Signed-off-by Elijah Newren <[email protected]>
---
 hashmap.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
hashmap.h +3 -3
index bd2701549f..6036069c23 100644
@@ -59,7 +59,7 @@
  *
  *         if (!strcmp("print_all_by_key", action)) {
  *             struct long2string k, *e;
- *             hashmap_entry_init(&k->ent, memhash(&key, sizeof(long)));
+ *             hashmap_entry_init(&k.ent, memhash(&key, sizeof(long)));
  *             k.key = key;
  *
  *             flags &= ~COMPARE_VALUE;

@@ -87,12 +87,12 @@
  *
  *         if (!strcmp("has_exact_match_no_heap_alloc", action)) {
  *             struct long2string k;
- *             hashmap_entry_init(&k->ent, memhash(&key, sizeof(long)));
+ *             hashmap_entry_init(&k.ent, memhash(&key, sizeof(long)));
  *             k.key = key;
  *
  *             flags |= COMPARE_VALUE;
  *             printf("%sfound\n",
- *                    hashmap_get(&map, &k->ent, value) ? "" : "not ");
+ *                    hashmap_get(&map, &k.ent, value) ? "" : "not ");
  *         }
  *
  *         if (!strcmp("end", action)) {
Signature · 1 line
gitgitgadget
#5 lore raw
In reply to Elijah Newren via GitGitGadget
Quoted 3 lines · Elijah Newren via GitGitGadget

In addition to the pile of spelling fixes in my other pull request, here are some simple documentation fixes other than spelling errors (remove repeated word, '.' vs '->', missing hyphen).

Thanks, these all look trivially correct to me.

-Peff

#4 lore raw

Re: [PATCH 3/3] name-hash.c: remove duplicate word in comment

In reply to Elijah Newren via GitGitGadget
Quoted 12 lines · Elijah Newren via GitGitGadget

From: Elijah Newren <[email protected]>

Signed-off-by Elijah Newren <[email protected]>
---
 name-hash.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
name-hash.c +0 -0
index ceb1d7bd6f..4885bae5da 100644

name-hash.c static int lookup_lazy_params(struct index_state *istate) · line 224

Quoted 8 lines
name-hash.c +1 -1
@@ -218,7 +218,7 @@ static int lookup_lazy_params(struct index_state *istate)
  * However, the hashmap is going to put items into bucket
  * chains based on their hash values.  Use that to create n
  * mutexes and lock on mutex[bucket(hash) % n].  This will
- * decrease the collision rate by (hopefully) by a factor of n.
+ * decrease the collision rate by (hopefully) a factor of n.
  */
 static void init_dir_mutex(void)
 {

Thanks. Will queue all 3.