Skip to content

Commit fd2ebf1

Browse files
tgummerergitster
authored andcommitted
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 <[email protected]> Helped-by: Jeff King <[email protected]> Signed-off-by: Thomas Gummerer <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent db37745 commit fd2ebf1

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

Documentation/git-stash.txt

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@ SYNOPSIS
1313
'git stash' drop [-q|--quiet] [<stash>]
1414
'git stash' ( pop | apply ) [--index] [-q|--quiet] [<stash>]
1515
'git stash' branch <branchname> [<stash>]
16-
'git stash' save [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]
17-
[-u|--include-untracked] [-a|--all] [<message>]
1816
'git stash' [push [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]
1917
[-u|--include-untracked] [-a|--all] [-m|--message <message>]]
2018
[--] [<pathspec>...]]
@@ -48,7 +46,6 @@ stash index (e.g. the integer `n` is equivalent to `stash@{n}`).
4846
OPTIONS
4947
-------
5048

51-
save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [<message>]::
5249
push [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [-m|--message <message>] [--] [<pathspec>...]::
5350

5451
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.
8784
The `--patch` option implies `--keep-index`. You can use
8885
`--no-keep-index` to override this.
8986

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+
9093
list [<options>]::
9194

9295
List the stash entries that you currently have. Each 'stash entry' is

0 commit comments

Comments
 (0)