threads / patch / 52197

patch, 3 partsOther doc fixes

Subject: [PATCH 0/3] Other doc fixes

## tl;dr

6 messages between Nov 5, 2019 and Nov 7, 2019. Diffs are folded; open one to read it.

replies: 5people: 3as markdown or json

Elijah Newren via GitGitGadget· Nov 5, 2019, 23:31 UTC · lore

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
-- 
gitgitgadget
Elijah Newren via GitGitGadget· Nov 5, 2019, 23:31 UTC · re: Elijah Newren via GitGitGadget · lore

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

From: Elijah Newren <newren@gmail.com>
Signed-off-by: Elijah Newren <newren@gmail.com>
---
 name-hash.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Show changes to name-hash.c +1 −1
diff --git a/name-hash.c b/name-hash.c
index ceb1d7bd6f..4885bae5da 100644
--- 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)
 {

-- 
gitgitgadget
Junio C Hamano· Nov 7, 2019, 05:41 UTC · re: Elijah Newren via GitGitGadget · lore

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

"Elijah Newren via GitGitGadget" <gitgitgadget@gmail.com> writes:
Show 20 quoted lines
> From: Elijah Newren <newren@gmail.com>
>
> Signed-off-by: Elijah Newren <newren@gmail.com>
> ---
>  name-hash.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/name-hash.c b/name-hash.c
> index ceb1d7bd6f..4885bae5da 100644
> --- 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)
>  {
Thanks.  Will queue all 3.
Elijah Newren via GitGitGadget· Nov 5, 2019, 23:31 UTC · re: Elijah Newren via GitGitGadget · lore

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

From: Elijah Newren <newren@gmail.com>
Signed-off-by: Elijah Newren <newren@gmail.com>
---
 Documentation/git-filter-branch.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Show changes to Documentation/git-filter-branch.txt +1 −1
diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt
index 5876598852..1ba4667b12 100644
--- 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

-- 
gitgitgadget
Elijah Newren via GitGitGadget· Nov 5, 2019, 23:31 UTC · re: Elijah Newren via GitGitGadget · lore

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

From: Elijah Newren <newren@gmail.com>
Signed-off-by: Elijah Newren <newren@gmail.com>
---
 hashmap.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
Show changes to hashmap.h +3 −3
diff --git a/hashmap.h b/hashmap.h
index bd2701549f..6036069c23 100644
--- 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)) {

-- 
gitgitgadget
Jeff King· Nov 6, 2019, 04:06 UTC · re: Elijah Newren via GitGitGadget · lore

Re: [PATCH 0/3] Other doc fixes

On Tue, Nov 05, 2019 at 11:31:29PM +0000, Elijah Newren via GitGitGadget wrote:
> 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

← back to recent threads