git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Eric Sunshine <sunshine@sunshineco.com>
To: Johannes Sixt <j6t@kdbg.org>
Cc: Vasco Almeida <vascomalmeida@sapo.pt>,
	Git Mailing List <git@vger.kernel.org>
Subject: Re: [PATCH va/i18n-even-more] rebase-interactive: trim leading whitespace from progress count
Date: Thu, 28 Jul 2016 14:22:03 -0400	[thread overview]
Message-ID: <CAPig+cSBZ_Vey2BW8S4D+7ufG1U3a-N402s4zZZJ2OE=xH1+tQ@mail.gmail.com> (raw)
In-Reply-To: <fa512576-487e-9b9c-3ada-7f0d9b135e4b@kdbg.org>

On Thu, Jul 28, 2016 at 1:47 PM, Johannes Sixt <j6t@kdbg.org> wrote:
> Interactive rebase uses 'wc -l' to write the current patch number
> in a progress report. Some implementations of 'wc -l' produce spaces
> before the number, leading to ugly output such as
>
>   Rebasing (     3/8)
>
> Remove the spaces using a trivial arithmetic evaluation.
>
> Before 9588c52 (i18n: rebase-interactive: mark strings for
> translation) this was not a problem because printf was used to
> generate the text. Since that commit, the count is interpolated
> directly from a shell variable into the text, where the spaces
> remain. The total number of patches does not have this problem
> even though it is interpolated from a shell variable in the same
> manner, because the variable is set by an arithmetic evaluation.
>
> Later in the script, there is a virtually identical case where
> leading spaces are trimmed, but it uses a pattern substitution:
>
> todocount=$(git stripspace --strip-comments <"$todo" | wc -l)
> todocount=${todocount##* }
>
> I did not choose this idiom because it adds a line of code, and
> there is already an arithmetic evaluation in the vicinity of the
> line that is changed here.

On the other hand, to a newcomer (not familiar with this patch),
${foo##* } is an obvious and intentional stripping of whitespace,
whereas taking advantage of a side-effect of arithmetic evaluation to
achieve the same is quite subtle and likely to be interpreted as
pointless, thus forces the reader to consult 'blame' to understand why
the code is the way it is.

> Signed-off-by: Johannes Sixt <j6t@kdbg.org>
> ---
> diff --git a/git-rebase--interactive.sh b/git-rebase--interactive.sh
> @@ -121,7 +121,7 @@ mark_action_done () {
>         sed -e 1q < "$todo" >> "$done"
>         sed -e 1d < "$todo" >> "$todo".new
>         mv -f "$todo".new "$todo"
> -       new_count=$(git stripspace --strip-comments <"$done" | wc -l)
> +       new_count=$(( $(git stripspace --strip-comments <"$done" | wc -l) ))
>         echo $new_count >"$msgnum"
>         total=$(($new_count + $(git stripspace --strip-comments <"$todo" | wc -l)))
>         echo $total >"$end"

  reply	other threads:[~2016-07-28 18:22 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-07-28 17:47 [PATCH va/i18n-even-more] rebase-interactive: trim leading whitespace from progress count Johannes Sixt
2016-07-28 18:22 ` Eric Sunshine [this message]
2016-07-28 18:45   ` Jakub Narębski
2016-07-28 20:30     ` 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='CAPig+cSBZ_Vey2BW8S4D+7ufG1U3a-N402s4zZZJ2OE=xH1+tQ@mail.gmail.com' \
    --to=sunshine@sunshineco.com \
    --cc=git@vger.kernel.org \
    --cc=j6t@kdbg.org \
    --cc=vascomalmeida@sapo.pt \
    /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).