stash: mark "git stash save" deprecated in the man page
'git stash push' fixes a historical wart in the interface of 'git stash save'. As 'git stash push' has all functionality of 'git stash save', with a nicer, more consistent user interface deprecate 'git stash save'. To do this, remove it from the synopsis of the man page, and move it to a separate section, stating that it is deprecated. Helped-by: Robert P. J. Day <rpjday@crashcourse.ca> Helped-by: Jeff King <peff@peff.net> Signed-off-by: Thomas Gummerer <t.gummerer@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Thomas Gummerer committed
Oct 22, 2017 at 18:04 UTC
fd2ebf14db52cc41e1cd39b1532d03cb1a702d47
1 file changed
+6
-3
Documentation/git-stash.txt
+6
-3
@@ -13,8 +13,6 @@ SYNOPSIS
13
'git stash' drop [-q|--quiet] [<stash>]
14
'git stash' ( pop | apply ) [--index] [-q|--quiet] [<stash>]
15
'git stash' branch <branchname> [<stash>]
16
-'git stash' save [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]
17
- [-u|--include-untracked] [-a|--all] [<message>]
16
'git stash' [push [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]
17
[-u|--include-untracked] [-a|--all] [-m|--message <message>]]
18
[--] [<pathspec>...]]
@@ -48,7 +46,6 @@ stash index (e.g. the integer `n` is equivalent to `stash@{n}`).
46
OPTIONS
47
-------
48
51
-save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [<message>]::
49
push [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [-m|--message <message>] [--] [<pathspec>...]::
50
51
Save your local modifications to a new 'stash entry' and roll them
@@ -87,6 +84,12 @@ linkgit:git-add[1] to learn how to operate the `--patch` mode.
84
The `--patch` option implies `--keep-index`. You can use
85
`--no-keep-index` to override this.
86
87
+save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [<message>]::
88
+
89
+ This option is deprecated in favour of 'git stash push'. It
90
+ differs from "stash push" in that it cannot take pathspecs,
91
+ and any non-option arguments form the message.
92
+
93
list [<options>]::
94
95
List the stash entries that you currently have. Each 'stash entry' is