git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [docs] git stash show also accepts -p|--patch option

From
MÅMartin Ågren <martin.agren@gmail.com>
Date
Apr 20, 2020, 16:19 UTC
Message-ID
<CAN0heSpO3bsi9dc2p1W_DJf1i2kH+Y8XjGo2bvqLkYTPSsfxWw@mail.gmail.com>
In-Reply-To
<CAJ9KuXwmk377rEPVrwwpWmwzyO8N20OZUkUTBRoQoo3OuVYbGw@mail.gmail.com>
Hi Elijah,
Welcome to the list. :-)
On Mon, 20 Apr 2020 at 09:36, Elijah Lynn <elijah@elijahlynn.net> wrote:
Show 10 quoted lines
>
> Was reading `git help stash`and noticed the --patch option says:
>
> > This option is only valid for `push` and `save` commands.
>
> But this isn't true, the `git stash show` command also accepts the
> --patch command and is very useful as it shows the diff of the stash
> whereas without --patch it just shows the filenames that changed. I
> see this text in master too
> https://github.com/git/git/blob/master/Documentation/git-stash.txt.
Interesting!

There are two *different* "--patch" involved here. One is used to interactively select hunks with "push" and "save". Another is the one from the "git-log/diff" machinery. This is the one that can be used with "git stash show" and "git stash list". That is, "git stash show" doesn't really know about it -- it just passes on "--patch" and other arguments.

For example, for "list", the manpage for git-stash says "The command takes options applicable to the git log command to control what is shown and how. See git-log(1)."

So there are in a sense lots of options that aren't documented in git-stash(1). But certainly "--patch" is a bit special in that there are basically two *different* options by the same name.

> I can gladly submit a patch if this will be acceptable to update the
> docs to state that -p|--patch is applicable to the `show` command as
> well.

I think it could be useful to be a bit clearer about this. One question is how... :-) Maybe under "--patch" one could make some short mention of this. Perhaps

  (`--patch` can also be used with "show" and "list", but that is
  'another' `--patch`, see ....)
? Maybe you have other ideas?

Thanks Martin

Previous: Elijah Lynn
Message 2 of 2 in “[docs] git stash show also accepts -p|--patch option”
  1. Elijah LynnApr 20, 2020
  2. Martin ÅgrenApr 20, 2020

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.