[v5,0/3] send-email: make produced outputs more readable

Message

Dragan Simic April 7, 2024, 10:48 a.m. UTC

* send-email: make produced outputs more readable by separating
   the result statuses and prompts from the subsequent messages

This series makes the outputs of "git send-mail" more readable, by
adding vertical whitespace to make discerning the messages produced
for each patch easy, and by adding vertical whitespace to separate the
emitted prompts from the other produced messages.  Having the prompts
and some of the produced messages bunched together made the navigation
through the produced outputs unnecessarily hard.

Making the outputs of "git send-mail" more readable is quite important,
because the Git users rather regularly complain about the workflows that
require project patches to be sent to various mailing lists.  Making the
produced outputs more readable can only help there.

Changes in v5:
    - Split into a three-patch series, because changes introduced in
      some versions of this patch made the original assumptions about
      squashing the changes together no longer apply [1]
    - Updated and extended the patch descriptions, to hopefully describe
      the changes performed in each patch a bit better

Changes in v4:
    - Dropped the changes to the styling of the produced prompts, as
      reasonably requested by Junio, [2] because it extended the scope
      of the patch with no good reason, and may also create issues on
      some platforms, whose Perl packages may actually not support the
      "->ornaments()" feature of Term::ReadLine
    - Updated the patch description and the "what's cooking" summary
      to cover the changes

Changes in v3:
    - Removed a redundant comment, as suggested by Junio [3]
    - Did the right thing and made the vertical separators emitted as
      message separators, instead of having them emitted as message
      terminators, as suggested by Junio [3]
    - Additional vertical whitespace is now also emitted after the
      prompt for sending emails, to "de-bunch" it from the subsequent
      messages and make discerning the messages easier
    - The above-mentioned prompt no longer uses underlined text, to make
      it significantly easier on the eyes
    - Fixed one indentation by spaces to use tabs and removed one stray
      newline in the source code, as spotted
    - Updated and extended the patch description to cover the changes
    - Updated the "what's cooking" summary to cover the changes
    - Cleaned up the older notes a bit

Changes in v2:
    - Improved the way additional newline separators are introduced to
      the source code, as suggested by Junio, [4], to help a bit with
      the translation efforts
    - Improved the patch subject and description a bit, to provide some
      additional information, as suggested by Junio [4]
    - Added a Helped-by tag

Notes for v1:
    - This is a resubmission of the patch I submitted about a week and
      a half ago; [5]  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, vs. the original patch

Link to v1: https://lore.kernel.org/git/[e-mail]/T/#u
Link to v2: https://lore.kernel.org/git/[e-mail]/T/#u
Link to v3: https://lore.kernel.org/git/[e-mail]/T/#u
Link to v4: https://lore.kernel.org/git/[e-mail]/T/#u

[1] https://lore.kernel.org/git/[e-mail]/
[2] https://lore.kernel.org/git/xmqq8r1rs39g.fsf@gitster.g/
[3] https://lore.kernel.org/git/xmqqzfu8yc40.fsf@gitster.g/
[4] https://lore.kernel.org/git/xmqqy19tylrm.fsf@gitster.g/
[5] https://lore.kernel.org/git/[e-mail]/

Dragan Simic (3):
  send-email: move newline character out of a translatable string
  send-email: make it easy to discern the messages for each patch
  send-email: separate the confirmation prompts from the messages

 git-send-email.perl | 17 ++++++++++++-----
 1 file changed, 12 insertions(+), 5 deletions(-)