src/git-checkpoint.1

   1 '\" t
   2 .\"     Title: git-checkpoint
   3 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
   5 .\"      Date: 02/22/2015
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-CHECKPOINT" "1" "02/22/2015" "Git" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * set default formatting
  13 .\" -----------------------------------------------------------------
  14 .\" disable hyphenation
  15 .nh
  16 .\" disable justification (adjust text to left margin only)
  17 .ad l
  18 .\" -----------------------------------------------------------------
  19 .\" * MAIN CONTENT STARTS HERE *
  20 .\" -----------------------------------------------------------------
  21 .SH "NAME"
  22 git-checkpoint \- Stash the changes in a dirty working directory away
  23 .SH "SYNOPSIS"
  24 .sp
  25 .nf
  26 \fIgit checkpoint\fR [<message>]
  27 .fi
  28 .sp
  29 .SH "DESCRIPTION"
  30 .sp
  31 Use git checkpoint when you want to record the current state of the working directory and the index, but do NOT want to go back to a clean working directory\&. The command saves your local modifications away without touching the index or working directory\&.
  32 .sp
  33 The modifications stashed away by this command can be listed with git stash list, inspected with git stash show, and restored (potentially on top of a different commit) with git stash apply\&. A stash is by default listed as "WIP on \fIbranchname\fR \&...", but you can give a more descriptive message on the command line when you create one\&.
  34 .sp
  35 The latest stash you created is stored in refs/stash; older stashes are found in the reflog of this reference and can be named using the usual reflog syntax (e\&.g\&. stash@{0} is the most recently created stash, stash@{1} is the one before it, stash@{2\&.hours\&.ago} is also possible)\&.
  36 .SH "SEE ALSO"
  37 .sp
  38 \fBgit-reflog\fR(1), \fBgit-stash\fR(1)