git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Johannes Schindelin <Johannes.Schindelin@gmx.de>
To: しらいしななこ <nanako3@bluebottle.com>
Cc: GIT <git@vger.kernel.org>, Junio C Hamano <gitster@pobox.com>
Subject: [PATCH] Add a manual page for git-stash
Date: Sat, 30 Jun 2007 16:44:39 +0100 (BST)	[thread overview]
Message-ID: <Pine.LNX.4.64.0706301644190.4438@racer.site> (raw)
In-Reply-To: <200706300539.l5U5dHLh003989@mi1.bluebottle.com>


Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
---
 Documentation/git-stash.txt |  116 +++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 116 insertions(+), 0 deletions(-)
 create mode 100644 Documentation/git-stash.txt

diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt
new file mode 100644
index 0000000..b109f6e
--- /dev/null
+++ b/Documentation/git-stash.txt
@@ -0,0 +1,116 @@
+git-stash(1)
+=============
+
+NAME
+----
+git-stash - Stash the changes in a dirty working directory away
+
+SYNOPSIS
+--------
+[verse]
+'git-stash' [clear]
+'git-stash' [list | show | apply] [<stashname>]
+
+DESCRIPTION
+-----------
+Use 'git stash' when you want to record the current state of the
+working directory and the index, but want to go back to a clean
+working directory.
+
+For example, if you have to pull, but are in the middle of some
+interesting work, not yet ready to be committed, use git-stash.
+
+The default operation (when called without options), is to save
+the changes away.
+
+
+OPTIONS
+-------
+clear::
+	Undo _all_ stashes (dangerous!).
+
+list [<stashname>]::
+	List all stashed states.
+
+show [<stashname>]::
+	Show a combined diff of the stashed working directory, index and
+	HEAD.
+
+apply [<stashname>]::
+	Try to apply the stashed changes to the current HEAD. You need
+	a clean working directory for that, i.e. you must not have changes
+	relative to HEAD in your working directory or index.
+
+<stashname>::
+	A name of a stashed state. Typically something like 'stash@{2}'
+	or 'stash@{2.days.ago}'.
+
+
+EXAMPLES
+--------
+
+Get to a clean working directory, quick:
+
+---------------------
+$ git stash
+---------------------
+
+See what you stashed:
+
+---------------------
+$ git stash list
+---------------------
+
+Inspect the last stashed state:
+
+---------------------
+$ git stash show
+---------------------
+
+Inspect the second last stashed state:
+
+--------------------------
+$ git stash show stash@{1}
+--------------------------
+
+Apply the second last stashed state:
+
+---------------------------
+$ git stash apply stash@{1}
+---------------------------
+
+
+DISCUSSION
+----------
+
+The state is saved as three commits:
+
+- HEAD,
+- a commit which contains the state of the index, which has HEAD as a
+  parent, and
+- a commit which contains the state of the working directory (only the
+  tracked files, though), which has both HEAD and the second commit
+  as parents.
+
+The third commit holds the complete information of the stash, and is
+stored as the ref 'refs/stash'.
+
+Since that commit does not have any reference to other stashed states,
+the stash listing relies on the reflog of 'refs/stash'. Therefore,
+the stashed states are garbage collected like all the other reflogs.
+
+
+SEE ALSO
+--------
+gitlink:git-commit[1],
+gitlink:git-log[1],
+gitlink:git-reflog[1]
+
+Author
+------
+Written by Johannes E. Schindelin <johannes.schindelin@gmx.de>
+
+
+GIT
+---
+Part of the gitlink:git[7] suite
-- 
1.5.2.2.3249.g33841

  parent reply	other threads:[~2007-06-30 15:44 UTC|newest]

Thread overview: 34+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-06-30  1:29 [PATCH (2nd try)] Add git-stash script しらいしななこ
2007-06-30  2:05 ` Johannes Schindelin
2007-06-30  5:37   ` [PATCH (3rd " しらいしななこ
2007-06-30  6:12     ` Jeff King
2007-06-30  6:25       ` Junio C Hamano
2007-06-30 15:41     ` Johannes Schindelin
2007-06-30 17:19       ` Junio C Hamano
2007-06-30 23:27       ` しらいしななこ
2007-06-30 15:44     ` Johannes Schindelin [this message]
2007-06-30 16:38       ` [PATCH] Add a manual page for git-stash Frank Lichtenheld
2007-06-30 17:48         ` Johannes Schindelin
2007-06-30 18:45           ` Frank Lichtenheld
2007-06-30 17:44       ` Junio C Hamano
2007-06-30 17:56         ` Johannes Schindelin
2007-06-30 18:13           ` Junio C Hamano
2007-06-30 18:44             ` Johannes Schindelin
2007-07-01  5:26           ` [PATCH] Document git-stash しらいしななこ
2007-07-01  6:48             ` Junio C Hamano
2007-07-01  8:07             ` Jeff King
2007-07-01  8:38               ` Junio C Hamano
2007-07-01  9:06               ` しらいしななこ
     [not found]               ` <200707010910.l619A23c027837@mi0.bluebottle.com>
2007-07-01  9:19                 ` Jeff King
2007-07-01 21:39                   ` Junio C Hamano
2007-07-02  4:08                     ` Jeff King
2007-07-01 21:54               ` Junio C Hamano
2007-07-01 22:57                 ` Johannes Schindelin
2007-07-02  4:10                 ` Jeff King
2007-07-02 10:33                   ` Johannes Schindelin
2007-07-02 10:44                     ` [PATCH] git-stash: Make "save" the default operation again Johannes Schindelin
2007-07-02 11:00                       ` Jeff King
2007-07-02 11:15                         ` Johannes Schindelin
2007-07-02 23:11                           ` Junio C Hamano
2007-07-01  5:20       ` [PATCH] Add a manual page for git-stash Junio C Hamano
2007-06-30 16:06     ` [PATCH] Add tests " Johannes Schindelin

Reply instructions:

You may reply publicly 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

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

  git send-email \
    --in-reply-to=Pine.LNX.4.64.0706301644190.4438@racer.site \
    --to=johannes.schindelin@gmx.de \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=nanako3@bluebottle.com \
    /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
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).