hashmap.h: fix minor typo

[s-i-d-d-i-s]

Hi folks ! I'm Siddharth from Google, I'm working on libification of Git, while going through the hashmap.h I found a minor typo in the documentation comment.

cc: Emily Shaffer emilyshaffer@google.com
cc: Jonathan Tan jonathantanmy@google.com
cc: Emily Shaffer nasamuffin@google.com

[gitgitgadget]

Welcome to GitGitGadget

Hi @s-i-d-d-i-s, and welcome to GitGitGadget, the GitHub App to send patch series to the Git mailing list from GitHub Pull Requests.

Please make sure that your Pull Request has a good description, as it will be used as cover letter. You can CC potential reviewers by adding a footer to the PR description with the following syntax:

CC: Revi Ewer <revi.ewer@example.com>, Ill Takalook <ill.takalook@example.net>

Also, it is a good idea to review the commit messages one last time, as the Git project expects them in a quite specific form:

• the lines should not exceed 76 columns,
• the first line should be like a header and typically start with a prefix like "tests:" or "revisions:" to state which subsystem the change is about, and
• the commit messages' body should be describing the "why?" of the change.
• Finally, the commit messages should end in a Signed-off-by: line matching the commits' author.

It is in general a good idea to await the automated test ("Checks") in this Pull Request before contributing the patches, e.g. to avoid trivial issues such as unportable code.

Contributing the patches

Before you can contribute the patches, your GitHub username needs to be added to the list of permitted users. Any already-permitted user can do that, by adding a comment to your PR of the form /allow. A good way to find other contributors is to locate recent pull requests where someone has been /allowed:

• Search: is:pr is:open "/allow"

Both the person who commented /allow and the PR author are able to /allow you.

An alternative is the channel #git-devel on the Libera Chat IRC network:

<newcontributor> I've just created my first PR, could someone please /allow me? https://github.com/gitgitgadget/git/pull/12345
<veteran> newcontributor: it is done
<newcontributor> thanks!

Once on the list of permitted usernames, you can contribute the patches to the Git mailing list by adding a PR comment /submit.

If you want to see what email(s) would be sent for a /submit request, add a PR comment /preview to have the email(s) sent to you. You must have a public GitHub email address for this. Note that any reviewers CC'd via the list in the PR description will not actually be sent emails.

After you submit, GitGitGadget will respond with another comment that contains the link to the cover letter mail in the Git mailing list archive. Please make sure to monitor the discussion in that thread and to address comments and suggestions (while the comments and suggestions will be mirrored into the PR by GitGitGadget, you will still want to reply via mail).

If you do not want to subscribe to the Git mailing list just to be able to respond to a mail, you can download the mbox from the Git mailing list archive (click the (raw) link), then import it into your mail program. If you use GMail, you can do this via:

curl -g --user "<EMailAddress>:<Password>" \
    --url "imaps://imap.gmail.com/INBOX" -T /path/to/raw.txt

To iterate on your change, i.e. send a revised patch or patch series, you will first want to (force-)push to the same branch. You probably also want to modify your Pull Request description (or title). It is a good idea to summarize the revision by adding something like this to the cover letter (read: by editing the first comment on the PR, i.e. the PR description):

Changes since v1:
- Fixed a typo in the commit message (found by ...)
- Added a code comment to ... as suggested by ...
...

To send a new iteration, just add another PR comment with the contents: /submit.

Need help?

New contributors who want advice are encouraged to join git-mentoring@googlegroups.com, where volunteers who regularly contribute to Git are willing to answer newbie questions, give advice, or otherwise provide mentoring to interested contributors. You must join in order to post or view messages, but anyone can join.

You may also be able to find help in real time in the developer IRC channel, #git-devel on Libera Chat. Remember that IRC does not support offline messaging, so if you send someone a private message and log out, they cannot respond to you. The scrollback of #git-devel is archived, though.

[s-i-d-d-i-s]

/preview

[gitgitgadget]

Error: User s-i-d-d-i-s is not yet permitted to use GitGitGadget

[nasamuffin]

/allow

[gitgitgadget]

User s-i-d-d-i-s is now allowed to use GitGitGadget.

[s-i-d-d-i-s]

/preview

[gitgitgadget]

Preview email sent as pull.1506.git.1680189661118.gitgitgadget@gmail.com

[s-i-d-d-i-s]

/submit

[gitgitgadget]

Submitted as pull.1506.git.1680190083688.gitgitgadget@gmail.com

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-1506/s-i-d-d-i-s/fix-typo-in-hashmap.h-v1

To fetch this version to local tag pr-1506/s-i-d-d-i-s/fix-typo-in-hashmap.h-v1:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-1506/s-i-d-d-i-s/fix-typo-in-hashmap.h-v1

[gitgitgadget]

On the Git mailing list, Emily Shaffer wrote (reply to this):

On Thu, Mar 30, 2023 at 03:28:03PM +0000, Siddharth Singh via GitGitGadget wrote:
> 
> 
> The word "no" should be "not".
> 
> Signed-off-by: Siddharth Singh <siddhartth@google.com>
> ---
>     hashmap.h: fix minor typo
>     
>     Hi folks ! I'm Siddharth from Google, I'm working on libification of
>     Git, while going through the hashmap.h I found a minor typo in the
>     documentation comment.
> 
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1506%2Fs-i-d-d-i-s%2Ffix-typo-in-hashmap.h-v1
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1506/s-i-d-d-i-s/fix-typo-in-hashmap.h-v1
> Pull-Request: https://github.com/gitgitgadget/git/pull/1506
> 
> Hi folks ! I'm Siddharth from Google, I'm working on
> libification of Git, while going through the hashmap.h
> I found a minor typo in the documentation comment.

Hi Siddharth!

The reason that your description showed up twice is because you included
it both in the GitGitGadget description[1] and the commit message[2]. As
you can see, either way works to get it into the patch description, but
if you use both it will be printed twice :) It's not a big deal as this
is part of the description and won't be part of the commit history, but
in case you want to avoid it in the future, now you know.

Of course the diff looks good to me - nice catch with the typo fix.

I'll also add for the rest of the list that git-core @ Google team
encouraged Siddharth to send this patch even though it's minor enough
that the list would often it churn, because it's Siddharth's first patch
to Git (of hopefully many) and it seemed like a good chance for him to
practice the workflow as well as introduce himself :)

Thanks for sending it, Siddharth.

Reviewed-by: Emily Shaffer <emilyshaffer@google.com>


> ---
>  hashmap.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/hashmap.h b/hashmap.h
> index 7251687d730..e2cf9c78d84 100644
> --- a/hashmap.h
> +++ b/hashmap.h
> @@ -270,7 +270,7 @@ void hashmap_clear_(struct hashmap *map, ssize_t offset);
>  #define hashmap_clear(map) hashmap_clear_(map, -1)
>  
>  /*
> - * Similar to hashmap_clear(), except that the table is no deallocated; it
> + * Similar to hashmap_clear(), except that the table is not deallocated; it
>   * is merely zeroed out but left the same size as before.  If the hashmap
>   * will be reused, this avoids the overhead of deallocating and
>   * reallocating map->table.  As with hashmap_clear(), you may need to free
> 
> base-commit: 8d90352acc5c855620042fdcc6092f23a276af6d
> -- 
> gitgitgadget

1: https://github.com/gitgitgadget/git/pull/1506#issue-1647302362
2: https://github.com/gitgitgadget/git/pull/1506/commits/a657138270f422ff43ac835884961c3dba1fe507

[gitgitgadget]

User Emily Shaffer <nasamuffin@google.com> has been added to the cc: list.

[gitgitgadget]

This branch is now known as ss/hashmap-typofix.

[gitgitgadget]

This patch series was integrated into seen via git@6ef085a.

[gitgitgadget]

This patch series was integrated into seen via git@7914b23.

[gitgitgadget]

This patch series was integrated into seen via git@411ce23.

[gitgitgadget]

This patch series was integrated into next via git@ac1e443.

[gitgitgadget]

This patch series was integrated into seen via git@479323a.

[gitgitgadget]

This patch series was integrated into seen via git@e5b6fc6.

[gitgitgadget]

This patch series was integrated into master via git@e5b6fc6.

[gitgitgadget]

This patch series was integrated into next via git@e5b6fc6.

[gitgitgadget]

Closed via e5b6fc6.