git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Dragan Simic <dsimic@manjaro.org>
Cc: git@vger.kernel.org
Subject: Re: [PATCH RESEND] send-email: make produced outputs more readable
Date: Thu, 04 Apr 2024 12:23:57 -0700	[thread overview]
Message-ID: <xmqqy19tylrm.fsf@gitster.g> (raw)
In-Reply-To: <62553db377c28458883b66bcdc0c58cc0f32d15b.1712250366.git.dsimic@manjaro.org> (Dragan Simic's message of "Thu, 4 Apr 2024 19:07:32 +0200")

Dragan Simic <dsimic@manjaro.org> writes:

> Notes:
>      * send-email: make produced outputs more readable by separating
>        the result statuses from the subsequent patch outputs
>     
>     This is a resubmission of the patch I submitted about a week and a half
>     ago. [1]  The patch subject in the original submission was selected in
>     a bit unfortunate way, which this submission corrects, and also improves
>     the patch description a bit.  There are no changes to the patch itself.

I tried to cram a bit more information than "output more readable"
that lacks in what way the result is easier to read.

    send-email: make boundaries between messages easier to spot

perhaps?

> diff --git a/git-send-email.perl b/git-send-email.perl
> index 821b2b3a135a..62505ab2707c 100755
> --- a/git-send-email.perl
> +++ b/git-send-email.perl
> @@ -1576,7 +1576,6 @@ sub send_message {
>  		print $sm "$header\n$message";
>  		close $sm or die $!;
>  	} else {
> -
>  		if (!defined $smtp_server) {
>  			die __("The required SMTP server is not properly defined.")
>  		}
> @@ -1686,9 +1685,9 @@ sub send_message {
>  		print $header, "\n";
>  		if ($smtp) {
>  			print __("Result: "), $smtp->code, ' ',
> -				($smtp->message =~ /\n([^\n]+\n)$/s), "\n";
> +				($smtp->message =~ /\n([^\n]+\n)$/s), "\n\n";
>  		} else {
> -			print __("Result: OK\n");
> +			print __("Result: OK\n\n");
>  		}

It would be nicer to instead add a single separate

		print "\n";

after these if/else alternatives, without touching the existing
message lines, I would think.  That way, existing message
translations do not have to change.

If we were to change the translatable string anyway, it would be
even better to remove the newline from the translatable part of the
message, rendering the thing to:

	if ($smtp) {
		print __("Result: "), ..., ($smtp->message =~ /.../);
  	} else {
		print __("Result: OK");
	}
	print "\n\n";

Strictly speaking, that is an orthogonal clean-up, so it may have to
make it into two patch series, one for preliminary clean-up "to
excise terminating newline out of translatable strings" patch that
adds a separate print that adds a single newline, plus the "make it
easier to spot where a message ends and another one starts" patch
that makes the new print statement that adds a single newline to
instead add two.  In a patch as simple as this one, however, I think
killing two birds with a stone, i.e., directly go to the "if we were
to change the translatable string anyway" final shape in a single
patch, would be fine.

Thanks.



  reply	other threads:[~2024-04-04 19:24 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-04-04 17:07 [PATCH RESEND] send-email: make produced outputs more readable Dragan Simic
2024-04-04 19:23 ` Junio C Hamano [this message]
2024-04-04 19:40   ` Dragan Simic

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=xmqqy19tylrm.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=dsimic@manjaro.org \
    --cc=git@vger.kernel.org \
    /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).