status: teach "status --short" to respect "--show-stash"
diff mbox series

Message ID 20191104100334.60537-1-ericvw@gmail.com
State New
Headers show
Series
  • status: teach "status --short" to respect "--show-stash"
Related show

Commit Message

Eric N. Vander Weele Nov. 4, 2019, 10:03 a.m. UTC
Enable printing the entries currently stashed away in the short format.
This prints the stash information after the path status to be symmetric
with "status --long --show-stash".

Signed-off-by: Eric N. Vander Weele <ericvw@gmail.com>
---
 Documentation/git-status.txt |  4 ++++
 wt-status.c                  | 17 +++++++++++++++++
 2 files changed, 21 insertions(+)

Comments

Junio C Hamano Nov. 6, 2019, 2:33 a.m. UTC | #1
"Eric N. Vander Weele" <ericvw@gmail.com> writes:

> Enable printing the entries currently stashed away in the short format.
> This prints the stash information after the path status to be symmetric
> with "status --long --show-stash".
>
> Signed-off-by: Eric N. Vander Weele <ericvw@gmail.com>
> ---
>  Documentation/git-status.txt |  4 ++++
>  wt-status.c                  | 17 +++++++++++++++++
>  2 files changed, 21 insertions(+)
>
> diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
> index 7731b45f07..c1afc3282c 100644
> --- a/Documentation/git-status.txt
> +++ b/Documentation/git-status.txt
> @@ -244,6 +244,10 @@ If -b is used the short-format status is preceded by a line
>  
>      ## branchname tracking info
>  
> +If --show-stash is used the short-format status is followed by a line
> +
> +    ## stash: <n> (entry|entries)
> +

Hmmmm.  Would readers misinterpret we are talking about a branch
whose name is stash something?  I am not suggesting to change ##
introducer to some random letters, which would break scripts even
worse.

Doesn't the Porcelain Format v1 call the same codepath as
shortstatus?  We promise that its output never changes to support
existing scripts, but now they will start seeing "## stash:" that
they do not understand and barf?

Isn't this information available to scripts that want to read from
porcelain v2 output format (which is meant to be extensible by
allowing easy-to-parse optional headers, which this stash thing
exactly is).

Thanks.
Eric N. Vander Weele Nov. 7, 2019, 10:31 a.m. UTC | #2
On Wed, Nov 06, 2019 at 11:33:42AM +0900, Junio C Hamano wrote:
> "Eric N. Vander Weele" <ericvw@gmail.com> writes:
> 
> > Enable printing the entries currently stashed away in the short format.
> > This prints the stash information after the path status to be symmetric
> > with "status --long --show-stash".
> >
> > Signed-off-by: Eric N. Vander Weele <ericvw@gmail.com>
> > ---
> >  Documentation/git-status.txt |  4 ++++
> >  wt-status.c                  | 17 +++++++++++++++++
> >  2 files changed, 21 insertions(+)
> >
> > diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
> > index 7731b45f07..c1afc3282c 100644
> > --- a/Documentation/git-status.txt
> > +++ b/Documentation/git-status.txt
> > @@ -244,6 +244,10 @@ If -b is used the short-format status is preceded by a line
> >  
> >      ## branchname tracking info
> >  
> > +If --show-stash is used the short-format status is followed by a line
> > +
> > +    ## stash: <n> (entry|entries)
> > +
> 
> Hmmmm.  Would readers misinterpret we are talking about a branch
> whose name is stash something?  I am not suggesting to change ##
> introducer to some random letters, which would break scripts even
> worse.

I could see where readers may misinterpret this as a branch name.  I
struggled coming up with something short while not being confusing and
thought the presence ':' followed by a space would be clear enough.

> Doesn't the Porcelain Format v1 call the same codepath as
> shortstatus?  We promise that its output never changes to support
> existing scripts, but now they will start seeing "## stash:" that
> they do not understand and barf?

I wasn't aware of the Porcelain formats in detail when originally
creating the patch - oops!  Naively I was following the same behavior as
'--branch' in the shortstatus code path.

Diving into this further, the Porcelain Format v1 does call the same
code path as shortstatus.  I see there is some handling in
builtin/commit.c for tweaking the behavior of the branch being showed.

The documentation indicates that the behavior never changes between Git
versions or based on user configuration.  'git status --porcelain=1'
will react to '--branch' but not when 'status.branch' is set to 'true',
which is congruent with the documentation.

> Isn't this information available to scripts that want to read from
> porcelain v2 output format (which is meant to be extensible by
> allowing easy-to-parse optional headers, which this stash thing
> exactly is).

It is not available in Porcelain Format v2... yet :).


I'm happy making '--show-stash' congruent with '--branch' in v1', which
is would be in line with documented behavior, displaying something in
v2 only, or both.  Let me know how you would like to proceed and I'll
rework the patch accordingly.
Junio C Hamano Nov. 7, 2019, 11:09 a.m. UTC | #3
"Eric N. Vander Weele" <ericvw@gmail.com> writes:

>> Isn't this information available to scripts that want to read from
>> porcelain v2 output format (which is meant to be extensible by
>> allowing easy-to-parse optional headers, which this stash thing
>> exactly is).
>
> It is not available in Porcelain Format v2... yet :).
>
>
> I'm happy making '--show-stash' congruent with '--branch' in v1', which
> is would be in line with documented behavior, displaying something in
> v2 only, or both.  Let me know how you would like to proceed and I'll
> rework the patch accordingly.

Quite honestly, you do not want to ask _me_.  If you left it to
me, I may say that, among the possible next step you listed, the
best one is to do nothing, as I do not want to see the stash info in
the "status --short" output ;-)

It probably is the safest to make it available first only in v2
format.  I do not know if that makes its utility too limited for the
purpose of the application you have in mind.
Eric N. Vander Weele Nov. 8, 2019, 3:24 a.m. UTC | #4
On Thu, Nov 07, 2019 at 08:09:34PM +0900, Junio C Hamano wrote:
> "Eric N. Vander Weele" <ericvw@gmail.com> writes:
>
> >> Isn't this information available to scripts that want to read from
> >> porcelain v2 output format (which is meant to be extensible by
> >> allowing easy-to-parse optional headers, which this stash thing
> >> exactly is).
> >
> > It is not available in Porcelain Format v2... yet :).
> >
> >
> > I'm happy making '--show-stash' congruent with '--branch' in v1',
> > which is would be in line with documented behavior, displaying
> > something in v2 only, or both.  Let me know how you would like to
> > proceed and I'll rework the patch accordingly.
>
> Quite honestly, you do not want to ask _me_.  If you left it to
> me, I may say that, among the possible next step you listed, the
> best one is to do nothing, as I do not want to see the stash info in
> the "status --short" output ;-)
>
> It probably is the safest to make it available first only in v2
> format.  I do not know if that makes its utility too limited for the
> purpose of the application you have in mind.

The application I had in mind was to remind me of potentially stray
stashes I may have forgotten about when working on a project.  I was
hoping to add "--show-stash" to my alias for "status --short --branch".

The v2 format is a bit too verbose for what I need and having color
output is a nice bonus when using "--short".  I don't feel strongly for
pushing this through, but I am happy with what I have learned through
the process of trying :).

Patch
diff mbox series

diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
index 7731b45f07..c1afc3282c 100644
--- a/Documentation/git-status.txt
+++ b/Documentation/git-status.txt
@@ -244,6 +244,10 @@  If -b is used the short-format status is preceded by a line
 
     ## branchname tracking info
 
+If --show-stash is used the short-format status is followed by a line
+
+    ## stash: <n> (entry|entries)
+
 Porcelain Format Version 1
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
diff --git a/wt-status.c b/wt-status.c
index cc6f94504d..c6d112081b 100644
--- a/wt-status.c
+++ b/wt-status.c
@@ -1956,6 +1956,20 @@  static void wt_shortstatus_print_tracking(struct wt_status *s)
 	fputc(s->null_termination ? '\0' : '\n', s->fp);
 }
 
+static void wt_shortstatus_print_stash(struct wt_status *s)
+{
+	int stash_count = 0;
+
+	for_each_reflog_ent("refs/stash", stash_count_refs, &stash_count);
+	if (stash_count > 0) {
+		color_fprintf(s->fp, color(WT_STATUS_HEADER, s), "## ");
+		status_printf_ln(s, GIT_COLOR_NORMAL,
+				 Q_("stash: %d entry",
+				    "stash: %d entries", stash_count),
+				 stash_count);
+	}
+}
+
 static void wt_shortstatus_print(struct wt_status *s)
 {
 	struct string_list_item *it;
@@ -1976,6 +1990,9 @@  static void wt_shortstatus_print(struct wt_status *s)
 
 	for_each_string_list_item(it, &s->ignored)
 		wt_shortstatus_other(it, s, "!!");
+
+	if (s->show_stash)
+		wt_shortstatus_print_stash(s);
 }
 
 static void wt_porcelain_print(struct wt_status *s)