Merge branch 'en/misc-doc-fixes'

gitster · gitster · commit 5149902ff9f2 · 2019-12-01T09:04:34.000-08:00
Misc doc fixes.

* en/misc-doc-fixes:
  name-hash.c: remove duplicate word in comment
  hashmap: fix documentation misuses of -&gt; versus .
  git-filter-branch.txt: correct argument name typo
diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt
@@ -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
diff --git a/hashmap.h b/hashmap.h
@@ -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)) {
diff --git a/name-hash.c b/name-hash.c
@@ -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)
 {

Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@`
`59`	`59`	`*`
`60`	`60`	`* if (!strcmp("print_all_by_key", action)) {`
`61`	`61`	`* struct long2string k, *e;`
`62`		`- * hashmap_entry_init(&k->ent, memhash(&key, sizeof(long)));`
	`62`	`+ * hashmap_entry_init(&k.ent, memhash(&key, sizeof(long)));`
`63`	`63`	`* k.key = key;`
`64`	`64`	`*`
`65`	`65`	`* flags &= ~COMPARE_VALUE;`
`@@ -87,12 +87,12 @@`
`87`	`87`	`*`
`88`	`88`	`* if (!strcmp("has_exact_match_no_heap_alloc", action)) {`
`89`	`89`	`* struct long2string k;`
`90`		`- * hashmap_entry_init(&k->ent, memhash(&key, sizeof(long)));`
	`90`	`+ * hashmap_entry_init(&k.ent, memhash(&key, sizeof(long)));`
`91`	`91`	`* k.key = key;`
`92`	`92`	`*`
`93`	`93`	`* flags \|= COMPARE_VALUE;`
`94`	`94`	`* printf("%sfound\n",`
`95`		`- * hashmap_get(&map, &k->ent, value) ? "" : "not ");`
	`95`	`+ * hashmap_get(&map, &k.ent, value) ? "" : "not ");`
`96`	`96`	`* }`
`97`	`97`	`*`
`98`	`98`	`* if (!strcmp("end", action)) {`
Original file line number	Diff line number	Diff line change
`@@ -218,7 +218,7 @@ static int lookup_lazy_params(struct index_state *istate)`
`218`	`218`	`* However, the hashmap is going to put items into bucket`
`219`	`219`	`* chains based on their hash values. Use that to create n`
`220`	`220`	`* mutexes and lock on mutex[bucket(hash) % n]. This will`
`221`		`- * decrease the collision rate by (hopefully) by a factor of n.`
	`221`	`+ * decrease the collision rate by (hopefully) a factor of n.`
`222`	`222`	`*/`
`223`	`223`	`static void init_dir_mutex(void)`
`224`	`224`	`{`