git@vger.kernel.org mailing list mirror (one of many)
 help / Atom feed
From: Thomas Gummerer <t.gummerer@gmail.com>
To: git@vger.kernel.org
Cc: Jeff King <peff@peff.net>, Jonathan Nieder <jrnieder@gmail.com>, Junio C Hamano <gitster@pobox.com>, "Robert P . J . Day" <rpjday@crashcourse.ca>, Thomas Gummerer <t.gummerer@gmail.com>
Subject: [PATCH v3 2/3] mark git stash push deprecated in the man page
Date: Sun, 22 Oct 2017 18:04:08 +0100
Message-ID: <20171022170409.8565-3-t.gummerer@gmail.com> (raw)
In-Reply-To: <20171022170409.8565-1-t.gummerer@gmail.com>

'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>
---
 Documentation/git-stash.txt | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt
index 53b2e60aeb..8be661007d 100644
--- a/Documentation/git-stash.txt
+++ b/Documentation/git-stash.txt
@@ -13,8 +13,6 @@ SYNOPSIS
 'git stash' drop [-q|--quiet] [<stash>]
 'git stash' ( pop | apply ) [--index] [-q|--quiet] [<stash>]
 'git stash' branch <branchname> [<stash>]
-'git stash' save [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]
-	     [-u|--include-untracked] [-a|--all] [<message>]
 'git stash' [push [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]
 	     [-u|--include-untracked] [-a|--all] [-m|--message <message>]]
 	     [--] [<pathspec>...]]
@@ -48,7 +46,6 @@ stash index (e.g. the integer `n` is equivalent to `stash@{n}`).
 OPTIONS
 -------
 
-save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [<message>]::
 push [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [-m|--message <message>] [--] [<pathspec>...]::
 
 	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.
 The `--patch` option implies `--keep-index`.  You can use
 `--no-keep-index` to override this.
 
+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.
+
 list [<options>]::
 
 	List the stash entries that you currently have.  Each 'stash entry' is
-- 
2.15.0.rc0.2.g8fac3e73c8.dirty


  parent reply index

Thread overview: 29+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-10-05 20:00 [RFC] deprecate git stash save? (was: Re: [PATCH 2/3] http-push: fix construction of hex value from path) Thomas Gummerer
2017-10-05 20:10 ` [PATCH 2/1] mention git stash push first in the man page Thomas Gummerer
2017-10-17  4:14   ` Jeff King
2017-10-17 21:45     ` Thomas Gummerer
2017-10-17 21:47       ` Jeff King
2017-10-19 18:08         ` Thomas Gummerer
2017-10-20  8:04           ` Robert P. J. Day
2017-10-21  6:20             ` Jeff King
2017-10-21  6:43               ` Robert P. J. Day
2017-10-12  0:56 ` [RFC] deprecate git stash save? Junio C Hamano
2017-10-12 11:14   ` Junio C Hamano
2017-10-16 18:19     ` Thomas Gummerer
2017-10-17  4:13 ` [RFC] deprecate git stash save? (was: Re: [PATCH 2/3] http-push: fix construction of hex value from path) Jeff King
2017-10-17 21:47   ` Thomas Gummerer
2017-10-19 18:33 ` [PATCH v2 1/2] replace git stash save with git stash push in the documentation Thomas Gummerer
2017-10-19 18:33   ` [PATCH v2 2/2] mark git stash push deprecated in the man page Thomas Gummerer
2017-10-21  6:28     ` Jeff King
2017-10-22 16:31       ` Thomas Gummerer
2017-10-22 17:04     ` [PATCH v3 0/3] deprecate git stash save Thomas Gummerer
2017-10-22 17:04       ` [PATCH v3 1/3] replace git stash save with git stash push in the documentation Thomas Gummerer
2017-10-22 17:04       ` Thomas Gummerer [this message]
2017-10-22 17:04       ` [PATCH v3 3/3] stash: remove now superfluos help for "stash push" Thomas Gummerer
2017-10-23  0:39       ` [PATCH v3 0/3] deprecate git stash save Jeff King
2017-10-23  1:19       ` Junio C Hamano
2017-10-23  5:18         ` Jeff King
2017-10-23  6:26           ` Junio C Hamano
2017-10-23  5:47         ` Robert P. J. Day
2017-10-23  1:32       ` Junio C Hamano
2017-10-21  6:26   ` [PATCH v2 1/2] replace git stash save with git stash push in the documentation Jeff King
2017-10-22 16:28     ` Thomas Gummerer

Reply instructions:

You may reply publically to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20171022170409.8565-3-t.gummerer@gmail.com \
    --to=t.gummerer@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=jrnieder@gmail.com \
    --cc=peff@peff.net \
    --cc=rpjday@crashcourse.ca \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

git@vger.kernel.org mailing list mirror (one of many)

Archives are clonable:
	git clone --mirror https://public-inbox.org/git
	git clone --mirror http://ou63pmih66umazou.onion/git
	git clone --mirror http://czquwvybam4bgbro.onion/git
	git clone --mirror http://hjrcffqmbrq6wope.onion/git

Newsgroups are available over NNTP:
	nntp://news.public-inbox.org/inbox.comp.version-control.git
	nntp://ou63pmih66umazou.onion/inbox.comp.version-control.git
	nntp://czquwvybam4bgbro.onion/inbox.comp.version-control.git
	nntp://hjrcffqmbrq6wope.onion/inbox.comp.version-control.git
	nntp://news.gmane.org/gmane.comp.version-control.git

 note: .onion URLs require Tor: https://www.torproject.org/
       or Tor2web: https://www.tor2web.org/

AGPL code for this site: git clone https://public-inbox.org/ public-inbox