From: Jari Aalto <jari.aalto@cante.net>
Date: Sat, 02 Feb 2008 14:03:48 GMT
Subject: [PATCH] Documentation/git-stash.txt: Adjust SYNOPSIS command syntax (2)
Message-ID: <tzkr4fqz.fsf_-_@blue.sea.net>
In-Reply-To: <m3lk637j3k.fsf@localhost.localdomain>

Adjust the command syntax to better reflect the call parameters:
[save] [message...] => [save [<message>]].

Signed-off-by: Jari Aalto <jari.aalto AT cante.net>
---
 > [Jakub Narebski] I think it would beb better if you split this patch
 > in two,

 ***********************************************************************
 This is reworked patch (No. 2)
 ***********************************************************************

 Documentation/git-stash.txt |    7 ++++---
 1 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt
index 9889806..cd0dc1b 100644
--- a/Documentation/git-stash.txt
+++ b/Documentation/git-stash.txt
@@ -9,7 +9,7 @@ SYNOPSIS
 --------
 [verse]
 'git-stash' (list | show [<stash>] | apply [<stash>] | clear)
-'git-stash' [save] [message...]
+'git-stash' [save [<message>]]
 
 DESCRIPTION
 -----------
@@ -36,11 +36,12 @@ is also possible).
 OPTIONS
 -------
 
-save::
+save [<message>]::
 
 	Save your local modifications to a new 'stash', and run `git-reset
 	--hard` to revert them.  This is the default action when no
-	subcommand is given.
+	subcommand is given. The <message> part is optional and gives
+	the description along with the stashed state.
 
 list::
 
-- 
1.5.4-rc5.GIT-dirty