diff mbox series

Documentation/RelNotes: fix a typo in 2.36's relnotes

Message ID d23e51b8dc78651dbd751473c0f8b3dcd6bc3ac6.1649883760.git.me@ttaylorr.com (mailing list archive)
State New, archived
Headers show
Series Documentation/RelNotes: fix a typo in 2.36's relnotes | expand

Commit Message

Taylor Blau April 13, 2022, 9:03 p.m. UTC
Signed-off-by: Taylor Blau <me@ttaylorr.com>
---
Noticed while reading the RelNotes for GitHub's release highlights blog
post.

I'm pretty sure that this is a typo for "not-so-uncommon", but I could
be wrong (in which case, feel free to drop this patch on the floor).

 Documentation/RelNotes/2.36.0.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--
2.35.1.73.gccc5557600

Comments

Junio C Hamano April 13, 2022, 9:13 p.m. UTC | #1
Taylor Blau <me@ttaylorr.com> writes:

> Signed-off-by: Taylor Blau <me@ttaylorr.com>
> ---
> Noticed while reading the RelNotes for GitHub's release highlights blog
> post.

Thanks as always for highlighting more interesting bits from the
flat-and-bland-list-of-changes which is what I prepare as the
release notes.

> - * A not-so-common mistake is to write a script to feed "git bisect
> + * A not-so-uncommon mistake is to write a script to feed "git bisect
>     run" without making it executable, in which case all tests will

I actually meant that this is "not a common mistake that deserves our
bandwidth but because a change was already made to help such a case,
why not take it".

We can probably rewrite _without_ mentioning our expectation of how
common it would be.

    A user can forget to make a script file executable before giving
    it to "git bisect run".  In such a case, all tests will exit ...
Taylor Blau April 13, 2022, 9:46 p.m. UTC | #2
On Wed, Apr 13, 2022 at 02:13:31PM -0700, Junio C Hamano wrote:
> Taylor Blau <me@ttaylorr.com> writes:
>
> > Signed-off-by: Taylor Blau <me@ttaylorr.com>
> > ---
> > Noticed while reading the RelNotes for GitHub's release highlights blog
> > post.
>
> Thanks as always for highlighting more interesting bits from the
> flat-and-bland-list-of-changes which is what I prepare as the
> release notes.

It's a pleasure to do. Thanks for maintaining the release notes in the
meantime which make my job much easier to do.

> > - * A not-so-common mistake is to write a script to feed "git bisect
> > + * A not-so-uncommon mistake is to write a script to feed "git bisect
> >     run" without making it executable, in which case all tests will
>
> I actually meant that this is "not a common mistake that deserves our
> bandwidth but because a change was already made to help such a case,
> why not take it".

Ha! I wasn't sure if that's what you meant or not. I think your
suggestion below is an appropriate way to remove the ambiguity. Thanks.

> We can probably rewrite _without_ mentioning our expectation of how
> common it would be.
>
>     A user can forget to make a script file executable before giving
>     it to "git bisect run".  In such a case, all tests will exit ...

Looks good to me.

Thanks,
Taylor
diff mbox series

Patch

diff --git a/Documentation/RelNotes/2.36.0.txt b/Documentation/RelNotes/2.36.0.txt
index d61ade21e2..98e1c97617 100644
--- a/Documentation/RelNotes/2.36.0.txt
+++ b/Documentation/RelNotes/2.36.0.txt
@@ -46,7 +46,7 @@  UI, Workflows & Features

  * "git branch" learned the "--recurse-submodules" option.

- * A not-so-common mistake is to write a script to feed "git bisect
+ * A not-so-uncommon mistake is to write a script to feed "git bisect
    run" without making it executable, in which case all tests will
    exit with 126 or 127 error codes, even on revisions that are marked
    as good.  Try to recognize this situation and stop iteration early.