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

Re: Bug report: Documentation error in git-bisect man description

From
MUManuel Ullmann <ullman.alias@posteo.de>
Date
Jan 13, 2017, 00:14 UTC
Message-ID
<87bmvbu874.fsf@sonnengebleicht.fritz.box>
In-Reply-To
<xmqq8tqfj15z.fsf@gitster.mtv.corp.google.com>

I see. Thanks for the clarification. The pairing not being pairs of opposites was indeed, what confused me. So that description was not meant in the sense, that you use these pairs when working with bisect, but instead they are ordered according to the argument possibilities.

Sorry for spreading confusion. I think the second paragraph should be sufficient for documentation.

Best regards Manuel

Show 46 quoted lines
> Junio C Hamano <gitster@pobox.com> writes:
>
>> Manuel Ullmann <ullman.alias@posteo.de> writes:
>>
>> Hmmm, I tend to agree, modulo a minor fix.
>>
>> If the description were in a context inside a paragraph like this:
>>
>> 	When you want to tell 'git bisect' that a <rev> belongs to
>> 	the newer half of the history, you say
>>
>> 		git bisect (bad|new) [<rev>]
>>
>> 	On the other hand, when you want to tell 'git bisect' that a
>> 	<rev> belongs to the older half of the history, you can say
>>
>> 		git bisect (good|old) [<rev>]
>>
>> then the pairing we see in the current text makes quite a lot of
>> sense.
>
> Actually, the above is _exactly_ what was intended.  I misread the
> current documentation when I made the comment, and I think that the
> current one _IS_ correct.  The latter half of the above is not about
> a single rev.  You can paint multiple commits with the "older half"
> color, i.e.
>
> 	On the other hand, when you want to tell 'git bisect' that
> 	one or more <rev>s  belong to the older half of the history,
> 	you can say
>
> 		git bisect (good|old) [<rev>...]
>
> In contrast, you can mark only one <rev> as newer (or "already
> bad").  So pairing (bad|good) and (new|old) like you suggested
> breaks the correctness of the command line description.
>
> If (bad|new) and (good|old) bothers you because they may mislead the
> readers to think bad is an opposite of new (and good is an opposite
> of old), the only solution I can think of to that problem is to
> expand these two lines into four and list them like this:
>
>         git bisect bad [<rev>]
>         git bisect good [<rev>...]
>         git bisect new [<rev>]
>         git bisect old [<rev>...]
Previous: Junio C HamanoNext: Christian Couder
Message 4 of 6 in “Bug report: Documentation error in git-bisect man description”
  1. Manuel UllmannJan 12, 2017
  2. Junio C HamanoJan 12, 2017
  3. Junio C HamanoJan 12, 2017
  4. Manuel UllmannJan 13, 2017
  5. Christian CouderJan 13, 2017
  6. Manuel UllmannJan 13, 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.