git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 1/2] doc: pull: explain what is a fast-forward

From
Felipe Contreras <felipe.contreras@gmail.com>
Date
Jun 25, 2021, 10:47 UTC
Message-ID
<60d5b430f2f13_ba7520890@natae.notmuch>
In-Reply-To
<87im22xpp4.fsf@evledraar.gmail.com>
Ævar Arnfjörð Bjarmason wrote:
Show 67 quoted lines
> 
> On Thu, Jun 24 2021, Felipe Contreras wrote:
> 
> > Philip Oakley wrote:
> >> On 24/06/2021 20:05, Felipe Contreras wrote:
> >> > Philip Oakley wrote:
> >> >> Hi Felipe,
> >> >> On 24/06/2021 15:31, Felipe Contreras wrote:
> >> >>> Philip Oakley wrote:
> >> >>>> On 21/06/2021 18:52, Felipe Contreras wrote:
> >> >>>>> --- a/Documentation/git-pull.txt
> >> >>>>> +++ b/Documentation/git-pull.txt
> >> >>>>> @@ -41,16 +41,41 @@ Assume the following history exists and the current branch is
> >> >>>>>  ------------
> >> >>>>>  	  A---B---C master on origin
> >> >>>>>  	 /
> >> >>>>> -    D---E---F---G master
> >> >>>>> +    D---E master
> >> >>>>>  	^
> >> >>>>>  	origin/master in your repository
> >> >>>>>  ------------
> >> >>>>>  
> >> >>>>>  Then "`git pull`" will fetch and replay the changes from the remote
> >> >>>>>  `master` branch since it diverged from the local `master` (i.e., `E`)
> >> >>>>> -until its current commit (`C`) on top of `master` and record the
> >> >>>>> -result in a new commit along with the names of the two parent commits
> >> >>>>> -and a log message from the user describing the changes.
> >> >>>>> +until its current commit (`C`) on top of `master`.
> >> >>>>> +
> >> >>>>> +After the remote changes have been synchronized, the local `master` will
> >> >>>>> +be fast-forwarded to the same commit as the remote one, therefore
> >> >>>> Perhaps s/be fast-forwarded/have been 'fast-forward'ed/ ?
> >> >>> No, there's multiple steps:
> >> >> My key point was to 'quote' the fast-forward term.
> >> > fast-forward is an English word [1], there's no need to quote it as if
> >> > it weren't.
> >> 
> >> You appear to be arguing that your "explain what is a fast-forward"
> >> (subject line of the patch) doesn't need, within the patch, to explain
> >> that it is about the term "fast-forward", being used in a Git specific
> >> way...
> >
> > When you are trying to explain the meaning of a word it's generally
> > better to not use that word in the explanation. For example if you are
> > trying to explain "recursion", but you use "recursion" in the
> > explanation, that kinds of defeats the purpose.
> >
> > So yes, in the sentence "the local `master` will be fast-forwarded to
> > the same commit as the remote one", the verb "fast-forwarded" can easily
> > be replaced with "advanced" and no meaning would be lost.
> >
> > The meaning of this "fast-forward" verb is the same as when you
> > fast-forward a tape, and is not git-specific.
> 
> Using quotes for a term like 'fast-forward' or some made up word like
> 'qibbix' doesn't just serve the purpose of clarifying which ones are in
> the dictionary, but also to establish that the quoted word is jargon
> within the context of the documentation.
> 
> If I invent a new and exciting way to cut grass I might say my new
> machine 'shaves' the grass. The word "shave" is something I assume
> everyone knows, but I'm making it clear that I'm referring to the
> exciting mode of operation of my new death machine.
> 
> So I think it Philip's suggestion makes sense. We're not talking about
> how to fast-forward a tape, but what happens in git when we use that
> term.

No. In this particular sentence we are using fast-forward *precisely* in the same way as a tape. We haven't even talked about what constitutes a "fast-forward" in git jargon.

Substitute the word "fast-forward", and the meaning remains intact:
  After the remote changes have been synchronized, the local `master`
  will be advanced to the same commit as the remote one, therefore
  creating a linear history.
As I already explained.
> As an aside after however many years of using git this is the first time
> I made the connection to that usage of the term, I thought it was jargon
> git invented. That's also something to consider,

I was in your camp, but after thinking deeply about what would be a better term than "fast-forward" (advance, forward, boost), I realized that in fact "fast-forward" is perfectly fine because it already exists in English and conveys precisely the meaning we want: quickly advance to a desired position.

> I've also actually seen an interacted with a tape record and VHS tape in
> my lifetime, but I suspect many readers of this documentation have not.
But they have pressed fast-forward on their Roku control, or whatever.

Not only is it part of modern technology, but it's even used inside films, TV shows, and video games. See TV Tropes for dozens of examples where inside the film they fast-forward [1].

Show 12 quoted lines
> This isn't something for your patch, but I wonder more generally if we
> shouldn't consider moving away from the term entirely, and just say a
> branch was one of:
> 
>     * advanced (or some other such term, forwarded?)
>     * rebased
>     * merged
> 
> The existence (and it being the default) of "merge --ff" makes that
> somewhat difficult, but in those cases we could and probably should just
> also say "advanced" (or whatever), since that's what happened, ditto a
> noop rebase.

I already thought about it and I don't think so. The word "advanced" doesn't hint where, how much, or how quickly, could very well be just one commit forward.

This is one of those rare occasions where I think the git project chose the perfect word.

Cheers.
[1] https://tvtropes.org/pmwiki/pmwiki.php/Main/FastForwardGag
-- 
Felipe Contreras
Previous: Ævar Arnfjörð BjarmasonNext: Ævar Arnfjörð Bjarmason
Message 12 of 40 in “pull: documentation improvements”
  1. 0/2 pull: documentation improvementsFelipe Contreras, Jun 21, 2021
  2. 1/2 doc: pull: explain what is a fast-forwardFelipe Contreras, Jun 21, 2021
  3. Bagas SanjayaJun 22, 2021
  4. Felipe ContrerasJun 23, 2021
  5. Philip OakleyJun 24, 2021
  6. Felipe ContrerasJun 24, 2021
  7. Philip OakleyJun 24, 2021
  8. Felipe ContrerasJun 24, 2021
  9. Philip OakleyJun 24, 2021
  10. Felipe ContrerasJun 24, 2021
  11. Ævar Arnfjörð BjarmasonJun 25, 2021
  12. Felipe ContrerasJun 25, 2021
  13. Ævar Arnfjörð BjarmasonJun 25, 2021
  14. Felipe ContrerasJun 25, 2021
  15. Kerry, RichardJun 25, 2021
  16. Felipe ContrerasJun 25, 2021
  17. Felipe ContrerasJun 25, 2021
  18. 2/2 pull: improve default warningFelipe Contreras, Jun 21, 2021
  19. Alex HenrieJun 21, 2021
  20. Felipe ContrerasJun 21, 2021
  21. Alex HenrieJun 21, 2021
  22. Felipe ContrerasJun 21, 2021
  23. Alex HenrieJun 22, 2021
  24. Felipe ContrerasJun 22, 2021
  25. Elijah NewrenJun 22, 2021
  26. Alex HenrieJun 22, 2021
  27. Elijah NewrenJun 23, 2021
  28. Felipe ContrerasJun 23, 2021
  29. Elijah NewrenJun 23, 2021
  30. Felipe ContrerasJun 23, 2021
  31. Felipe ContrerasJun 23, 2021
  32. Elijah NewrenJun 23, 2021
  33. Felipe ContrerasJun 23, 2021
  34. Alex HenrieJun 24, 2021
  35. Felipe ContrerasJun 24, 2021
  36. Alex HenrieJun 27, 2021
  37. Felipe ContrerasJun 27, 2021
  38. 0/2 pull: documentation improvementsFelipe Contreras, Jun 23, 2021
  39. 1/2 doc: pull: explain what is a fast-forwardFelipe Contreras, Jun 23, 2021
  40. 2/2 pull: improve default warningFelipe Contreras, Jun 23, 2021

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.