git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: "Reuven Y. via GitGitGadget" <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, "Reuven Y." <robi@post.jce.ac.il>
Subject: Re: [PATCH] docs: typo in glossary content
Date: Wed, 19 May 2021 16:38:48 +0900	[thread overview]
Message-ID: <xmqqtumzxjef.fsf@gitster.g> (raw)
In-Reply-To: <pull.957.git.1621406381404.gitgitgadget@gmail.com> (Reuven Y. via GitGitGadget's message of "Wed, 19 May 2021 06:39:40 +0000")

"Reuven Y. via GitGitGadget" <gitgitgadget@gmail.com> writes:

> diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt
> index 67c7a50b96a0..e75aed00ffe1 100644
> --- a/Documentation/glossary-content.txt
> +++ b/Documentation/glossary-content.txt
> @@ -146,7 +146,7 @@ current branch integrates with) obviously do not work, as there is no
>  	<<def_revision,revision>> and you are "merging" another
>  	<<def_branch,branch>>'s changes that happen to be a descendant of what
>  	you have. In such a case, you do not make a new <<def_merge,merge>>
> -	<<def_commit,commit>> but instead just update to his
> +	<<def_commit,commit>> but instead just update to this
>  	revision. This will happen frequently on a
>  	<<def_remote_tracking_branch,remote-tracking branch>> of a remote
>  	<<def_repository,repository>>.

Actually, "his" is what was intended by the original introduced at
9290cd58 (Added definitions for a few words:, 2006-05-03).  

The "fast-forward" situation it describes happens when you try to
merge somebody else's history into your history, and if you do not
have anything of your own since the history of the other party
forked from your history.  In such a situation, instead of creating
a merge commit whose parents are the tip of your history and the tip
of the history of the other party, you just update the pointer that
points at the tip of your history (i.e. HEAD) to point at the commit
at the tip of the history of the other party.

One would refer to that commit, as "the tip of _HIS_ history", if
one does not bother trying to be gender neutral by repeatedly saying
"the other party".  So, "his" you touched is correct.  The
description that leads to this part talks about two "revisions"
(i.e. the one you have, and the other one you are merging), and
rewriting it to "this" revision makes it unclear which one is meant.

I do not mind neutering the expression with "the other party",
especially since that would help reduce confusion.  How about
phrasing

    In such a case, you do not make a new <<def_merge,merge>>
    <<def_commit,commit>>, but instead just update your branch to
    point at the same revision as the other party's.  This will
    happen often ...

perhaps?

Thanks.

  reply	other threads:[~2021-05-19  7:39 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-19  6:39 [PATCH] docs: typo in glossary content Reuven Y. via GitGitGadget
2021-05-19  7:38 ` Junio C Hamano [this message]
2021-05-19  8:36   ` Junio C Hamano
2021-05-19  9:28 ` [PATCH v2] docs: improve fast-forward " Reuven Y. via GitGitGadget
2021-05-19 12:10   ` Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqtumzxjef.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    --cc=robi@post.jce.ac.il \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).