]> git.ipfire.org Git - thirdparty/git.git/commitdiff
doc(stash): clarify the description of `save`
authorJohannes Schindelin <johannes.schindelin@gmx.de>
Thu, 10 Oct 2019 10:06:41 +0000 (03:06 -0700)
committerJunio C Hamano <gitster@pobox.com>
Fri, 11 Oct 2019 05:28:04 +0000 (14:28 +0900)
The original phrasing of this paragraph made at least one person stumble
over the word "from" (thinking that it was a typo and "from" was
intended), and other readers chimed in, agreeing that it was confusing:
https://public-inbox.org/git/0102016b8d597569-c1f6cfdc-cb45-4428-8737-cb1bc30655d8-000000@eu-west-1.amazonses.com/#t

Let's rewrite that paragraph for clarity.

Inspired-by-a-patch-by: Catalin Criste <cris_linu_w@yahoo.com>
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-stash.txt

index 8fbe12c66c823bce8756eaf3c836d5e8f0f7a340..53e1a1205d3088ed83300df89a02216dd46e556f 100644 (file)
@@ -87,8 +87,9 @@ The `--patch` option implies `--keep-index`.  You can use
 save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [<message>]::
 
        This option is deprecated in favour of 'git stash push'.  It
-       differs from "stash push" in that it cannot take pathspecs,
-       and any non-option arguments form the message.
+       differs from "stash push" in that it cannot take pathspecs.
+       Instead, all non-option arguments are concatenated to form the stash
+       message.
 
 list [<options>]::