git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Joakim Petersen <joak-pet@online.no>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org, "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
	"Justin Donnelly" <justinrdonnelly@gmail.com>
Subject: Re: [PATCH v7] git-prompt: make colourization consistent
Date: Thu, 9 Jun 2022 13:16:31 +0200	[thread overview]
Message-ID: <2b48b94e-44e7-9abb-4afe-51060b6b298a@online.no> (raw)
In-Reply-To: <xmqqzgiozbn8.fsf@gitster.g>

On 07/06/2022 18:22, Junio C Hamano wrote:
> Joakim Petersen <joak-pet@online.no> writes:
> 
>> The short upstream state indicator inherits the colour of the last short
>> state indicator before it (if there is one), and the sparsity state
>> indicator inherits this colour as well. This behaviour was introduced by
>> 0ec7c23cdc6 (git-prompt: make upstream state indicator location
>> consistent, 2022-02-27), while before this change the aforementioned
>> indicators were white/the default text colour. Some examples to
>> illustrate this behaviour (assuming all indicators are enabled and
>> colourization is on):
>>   * If there is something in the stash, both the '$' and the short
>>     upstream state indicator following it will be blue.
>>   * If the local tree has new, untracked files and there is nothing in
>>     the stash, both the '%' and the short upstream state indicator
>>     will be red.
>>   * If all local changes are added to the index and the stash is empty,
>>     both the '+' and the short upstream state indicator following it will
>>     be green.
>>   * If the local tree is clean and there is nothing in the stash, the
>>     short upstream state indicator will be white/${default text colour}.
>>
>> This appears to be an unintended side-effect of the change, and makes
>> little sense semantically (e.g. why is it bad to be in sync with
>> upstream when you have uncommitted local changes?). The cause of the
>> change in colourization is that previously, the short upstream state
>> indicator appeared immediately after the rebase/revert/bisect/merge
>> state indicator (note the position of $p in $gitstring):
>>
>> 	local f="$h$w$i$s$u"
>> 	local gitstring="$c$b${f:+$z$f}${sparse}$r$p"
>> 	
>> Said indicator is prepended with the clear colour code, and the short
>> upstream state indicator is thus also uncoloured. Now, the short
>> upstream state indicator follows the sequence of colourized indicators,
>> without any clearing of colour (again note the position of $p, now in
>> $f):
>>
>> 	local f="$h$w$i$s$u$p"
>> 	local gitstring="$c$b${f:+$z$f}${sparse}$r${upstream}"
>>
>> If the user is in a sparse checkout, the sparsity state indicator
>> follows a similar pattern to the short upstream state indicator.
>> However, clearing colour of the colourized indicators changes how the
>> sparsity state indicator is colourized, as it currently inherits (and
>> before the change referenced also inherited) the colour of the last
>> short state indicator before it. Reading the commit message of the
>> change that introduced the sparsity state indicator, afda36dbf3b
>> (git-prompt: include sparsity state as well, 2020-06-21), it appears
>> this colourization also was unintended, so clearing the colour for said
>> indicator further increases consistency.
>>
>> Make the colourization of these state indicators consistent by making
>> all colourized indicators clear their own colour. Make colouring of $c
>> dependent on it not being empty, as it is no longer being used to colour
>> the branch name. Move clearing of $b's prefix to before colourization so
>> it gets cleared properly when colour codes are inserted into it. These
>> changes make changing the layout of the prompt less prone to unintended
>> colour changes in the future.
>>
>> Change coloured Bash prompt tests to reflect the colourization changes:
>>   * Move the colour codes to wrap the expected content of the expanded
>>     $__git_ps1_branch_name in all tests.
>>   * Insert a clear-colour code after the symbol for the first indicator
>>     in "prompt - bash color pc mode - dirty status indicator - dirty
>>     index and worktree", to reflect that all indicators should clear
>>     their own colour.
>>
>> Signed-off-by: Joakim Petersen <joak-pet@online.no>
>> ---
>> Changes since v6:
>>   * Remove repeated statements and move all explanation of what the patch
>>     does to the latter part of the message.
>>   * Add a short statement about other benefits of the behavioural change.
> 
> The handling of $w is different from the original (it used to be
> that only '*' was painted in red, now any non-empty strings do), but
> '*' is the only value that can be assigned to $w, so there is no
> material difference.
> 
> Looking good.  Will queue.  Thanks.
> 

The change regarding $w was mentioned below --- for v5:
 > Changes since v4:
 >  * The check for whether to colourize $w has been altered to match the
 >    checks for the other indicators.
I'll add a mention of this to the commit message as well.

  reply	other threads:[~2022-06-09 11:16 UTC|newest]

Thread overview: 43+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-06-01 13:44 [RFC PATCH] git-prompt: make colourization consistent Joakim Petersen
2022-06-01 14:47 ` Ævar Arnfjörð Bjarmason
2022-06-01 18:26   ` Joakim Petersen
2022-06-01 18:07 ` Junio C Hamano
2022-06-01 18:32   ` Joakim Petersen
2022-06-01 20:45     ` Junio C Hamano
2022-06-02 14:59 ` [PATCH v2] " Joakim Petersen
2022-06-02 21:56   ` joak-pet
2022-06-02 22:49   ` Junio C Hamano
2022-06-03 13:55     ` Joakim Petersen
2022-06-03 14:25   ` [PATCH v3] " Joakim Petersen
2022-06-03 16:38     ` Junio C Hamano
2022-06-03 17:23       ` Joakim Petersen
2022-06-03 18:51         ` Joakim Petersen
2022-06-03 19:43           ` Justin Donnelly
2022-06-03 21:16             ` Junio C Hamano
2022-06-04  9:42               ` Joakim Petersen
2022-06-06 16:13                 ` Junio C Hamano
2022-06-03 20:50         ` Junio C Hamano
2022-06-04 16:13     ` [PATCH v4] " Joakim Petersen
2022-06-04 17:30       ` Justin Donnelly
2022-06-04 19:18         ` Joakim Petersen
2022-06-04 19:26       ` [PATCH v5] " Joakim Petersen
2022-06-06  7:23         ` Bagas Sanjaya
2022-06-07 16:04           ` Junio C Hamano
2022-06-09 11:25             ` Joakim Petersen
2022-06-06 16:29         ` Junio C Hamano
2022-06-06 17:31           ` Joakim Petersen
2022-06-06 17:41             ` Junio C Hamano
2022-06-07 11:49               ` Joakim Petersen
2022-06-06 17:50         ` [PATCH v6] " Joakim Petersen
2022-06-07 11:50           ` [PATCH v7] " Joakim Petersen
2022-06-07 16:22             ` Junio C Hamano
2022-06-09 11:16               ` Joakim Petersen [this message]
2022-06-09  9:03             ` SZEDER Gábor
2022-06-09 11:13               ` Joakim Petersen
2022-06-09 18:29                 ` Junio C Hamano
2022-06-11  9:01                   ` SZEDER Gábor
2022-06-09 11:44             ` [PATCH v8] git-prompt: make colouring consistent Joakim Petersen
2022-06-09 20:44             ` [PATCH] git-prompt: fix expansion of branch colour codes Joakim Petersen
2022-06-10  0:05               ` Junio C Hamano
2022-06-10  0:33                 ` Joakim Petersen
2022-06-10  0:47               ` [PATCH v2] " Joakim Petersen

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

  List information: http://vger.kernel.org/majordomo-info.html

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

  git send-email \
    --in-reply-to=2b48b94e-44e7-9abb-4afe-51060b6b298a@online.no \
    --to=joak-pet@online.no \
    --cc=avarab@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=justinrdonnelly@gmail.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.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

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 read-only IMAP folder(s) and NNTP newsgroup(s).