git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Eric Sunshine <sunshine@sunshineco.com>
Cc: Eric Sunshine <ericsunshine@charter.net>,
	 git@vger.kernel.org,  Jeff King <peff@peff.net>
Subject: Re: [PATCH 1/2] chainlint: make error messages self-explanatory
Date: Fri, 30 Aug 2024 11:41:08 -0700	[thread overview]
Message-ID: <xmqqv7zhrgzf.fsf@gitster.g> (raw)
In-Reply-To: <CAPig+cQ+6am7-BSnWZz5=C0Q1Vyng0T4goB+ZE9TKJMrpi_Jpg@mail.gmail.com> (Eric Sunshine's message of "Thu, 29 Aug 2024 18:04:43 -0400")

Eric Sunshine <sunshine@sunshineco.com> writes:

> How about this?
>
>     The "?!LOOP?!" case is particularly serious because that terse
>     single word does nothing to convey that the loop body should end
>     with "|| return 1" (or "|| exit 1" in a subshell) to ensure that a
>     failing command in the body aborts the loop immediately, which is
>     important since a shell loop does not automatically terminate when
>     an error occurs within its body. Moreover, unlike &&-chaining
>     which is ubiquitous in Git tests, the "|| return 1" idiom is
>     relatively infrequent, thus may be harder for a newcomer to
>     discover by consulting nearby code.

Strike ", which is important since .*\ its body." and the above
reads perfect.

>> > -# name and the test body with a `?!FOO?!` annotation at the location of each
>> > +# name and the test body with a `?!ERR?!` annotation at the location of each
>> >  # detected problem, where "FOO" is a tag such as "AMP" which indicates a broken
>>
>> "FOO" -> "ERR"?
>
> Yep. Sharp eyes.

OK.  I'll mark the topic to be expecting a reroll for these small
messaging plus "ERR" -> "ERR:" but without other larger changes
mentioned in the thread.

Thanks.

  reply	other threads:[~2024-08-30 18:41 UTC|newest]

Thread overview: 29+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-08-29  9:16 [PATCH 0/2] make chainlint output more newcomer-friendly Eric Sunshine
2024-08-29  9:16 ` [PATCH 1/2] chainlint: make error messages self-explanatory Eric Sunshine
2024-08-29 10:03   ` Patrick Steinhardt
2024-08-29 17:07     ` Jeff King
2024-08-29 18:10       ` Eric Sunshine
2024-08-29 18:01     ` Eric Sunshine
2024-08-29 15:39   ` Junio C Hamano
2024-08-29 22:04     ` Eric Sunshine
2024-08-30 18:41       ` Junio C Hamano [this message]
2024-08-29  9:16 ` [PATCH 2/2] chainlint: reduce annotation noise-factor Eric Sunshine
2024-08-29 10:03   ` Patrick Steinhardt
2024-08-29 17:10     ` Jeff King
2024-08-29 18:37       ` Eric Sunshine
2024-08-29 18:28     ` Eric Sunshine
2024-08-29 15:55   ` Junio C Hamano
2024-08-30 23:30     ` Eric Sunshine
2024-08-30 23:51       ` Junio C Hamano
2024-09-10  4:10 ` [PATCH v2 0/3] make chainlint output more newcomer-friendly Eric Sunshine
2024-09-10  4:10   ` [PATCH v2 1/3] chainlint: don't be fooled by "?!...?!" in test body Eric Sunshine
2024-09-10 16:48     ` Junio C Hamano
2024-09-10  4:10   ` [PATCH v2 2/3] chainlint: make error messages self-explanatory Eric Sunshine
2024-09-10  7:48     ` Patrick Steinhardt
2024-09-10  4:10   ` [PATCH v2 3/3] chainlint: reduce annotation noise-factor Eric Sunshine
2024-09-10  7:48     ` Patrick Steinhardt
2024-09-10  8:14       ` Eric Sunshine
2024-09-10 15:42         ` Junio C Hamano
2024-09-10 22:17           ` Eric Sunshine
2024-09-10  6:44   ` [PATCH v2 0/3] make chainlint output more newcomer-friendly Jeff King
2024-09-10 17:31   ` 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

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

  git send-email \
    --in-reply-to=xmqqv7zhrgzf.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=ericsunshine@charter.net \
    --cc=git@vger.kernel.org \
    --cc=peff@peff.net \
    --cc=sunshine@sunshineco.com \
    /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.
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 NNTP newsgroup(s).