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

Re: [PATCH v2] doc: clarify that "git bisect" accepts one or more good commits

From
Robert P. J. Day <rpjday@crashcourse.ca>
Date
Nov 24, 2017, 09:11 UTC
Message-ID
<alpine.LFD.2.21.1711240351170.30318@localhost.localdomain>
In-Reply-To
<xmqqh8tkp9nn.fsf@gitster.mtv.corp.google.com>
On Fri, 24 Nov 2017, Junio C Hamano wrote:
> "Robert P. J. Day" <rpjday@crashcourse.ca> writes:
... snip ...
Show 6 quoted lines
> > -to indicate that it was after.
> > +to indicate a single commit after that change.
>
> As to "identify", I would say it is better to consistently use
> "indicate" like the original of these two hunks at the end says,
> i.e. "indicate that it is bad/new (or they are good/old)".
  i'm going to ponder this, but let me explain why i am such an
annoying stickler for the choice of words at times, and you can read
all about it here:
  http://twain.lib.virginia.edu/projects/rissetto/offense.html

in particular, i draw your attention to twain's trashing of cooper for, in many cases, using *almost* the right word, but not *quite* the right word:

"Cooper's word-sense was singularly dull. When a person has a poor ear for music he will flat and sharp right along without knowing it. He keeps near the tune, but is not the tune. When a person has a poor ear for words, the result is a literary flatting and sharping; you perceive what he is intending to say, but you also perceive that he does not say it. This is Cooper. He was not a word-musician. His ear was satisfied with the approximate words. I will furnish some circumstantial evidence in support of this charge. My instances are gathered from half a dozen pages of the tale called "Deerslayer." He uses "Verbal" for "oral"; "precision" for "facility"; "phenomena" for "marvels"; "necessary" for "predetermined"; "unsophisticated" for "primitive"; "preparation" for "expectancy"; "rebuked" for "subdued"; "dependent on" for "resulting from"; "fact" for "condition"; "fact" for "conjecture"; "precaution" for "caution"; "explain" for "determine"; "mortified" for "disappointed"; "meretricious" for "factitious"; "materially" for "considerably"; "decreasing" for "deepening"; "increasing" for "disappearing"; "embedded" for "inclosed"; "treacherous" for "hostile"; "stood" for "stooped"; "softened" for "replaced"; "rejoined" for "remarked"; "situation" for "condition"; "different" for "differing"; "insensible" for "unsentient"; "brevity" for "celerity"; "distrusted" for "suspicious"; "mental imbecility" for "imbecility"; "eyes" for "sight"; "counteracting" for "opposing"; "funeral obsequies" for "obsequies."

  in this sense, i don't think "indicate" and "identify" are
completely interchangeable. in my mind, the word "identify" does
nothing more than, you know, point at something and say, "that one,
that's the one i'm talking about;" it goes no further than that.
  on the other hand, the word "indicate" (in my mind) implies that
you're about to provide some *property* or *quality* of something, and
you do exactly that in the earlier quote:
> As to "identify", I would say it is better to consistently use
> "indicate" like the original of these two hunks at the end says,
> i.e. "indicate that it is bad/new (or they are good/old)".
  as in, you "identify" a commit, but you "indicate" that it
represents a good or bad commit. i know this sounds picky, but it is
exactly this tendency of using *almost* the right word that makes a
lot of documentation potentially confusing. given this distinction,
depending on the word to be used, i would write one of:
1) "first, identify the bad commit and one or more good commits..."
2) "first, indicate which commit is the bad commit, and which commits
are the good commits ..."
  the eventual meaning *should* be the same, but the choice of words
can make the meaning clear, or can confuse the reader.
  thoughts?
rday
-- 
========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================
Previous: Junio C HamanoNext: Junio C Hamano
Message 3 of 5 in “doc: clarify that "git bisect" accepts one or more good commits”
  1. doc: clarify that "git bisect" accepts one or more good commitsRobert P. J. Day, Nov 22, 2017
  2. Junio C HamanoNov 24, 2017
  3. Robert P. J. DayNov 24, 2017
  4. Junio C HamanoNov 24, 2017
  5. Junio C HamanoNov 24, 2017

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.