'\" t
.\" Title: stg-refresh
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1
.\" Date: 03/26/2014
.\" Manual: StGit Manual
.\" Source: StGit
.\" Language: English
.\"
.TH "STG\-REFRESH" "1" "03/26/2014" "StGit" "StGit Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
stg-refresh \- Generate a new commit for the current patch
.SH "SYNOPSIS"
.sp
.nf
\fIstg\fR refresh [options] [\-\-] []
.fi
.SH "DESCRIPTION"
Include the latest work tree and index changes in the current patch\&. This command generates a new git commit object for the patch; the old commit is no longer visible\&.
Refresh will warn if the index is dirty, and require use of either the \fI\-\-index\fR or \fI\-\-force\fR options to override this check\&. This is to prevent accidental full refresh when only some changes were staged using git add interative mode\&.
You may optionally list one or more files or directories relative to the current working directory; if you do, only matching files will be updated\&.
Behind the scenes, stg refresh first creates a new temporary patch with your updates, and then merges that patch into the patch you asked to have refreshed\&. If you asked to refresh a patch other than the topmost patch, there can be conflicts; in that case, the temporary patch will be left for you to take care of, for example with stg squash\&.
The creation of the temporary patch is recorded in a separate entry in the patch stack log; this means that one undo step will undo the merge between the other patch and the temp patch, and two undo steps will additionally get rid of the temp patch\&.
.SH "OPTIONS"
.PP
\-u, \-\-update
.RS 4
Only update the current patch files\&.
.RE
.PP
\-i, \-\-index
.RS 4
Instead of setting the patch top to the current contents of the worktree, set it to the current contents of the index\&.
.RE
.PP
\-F, \-\-force
.RS 4
Instead of warning the user when some work has already been staged (such as with git add interactive mode) force a full refresh\&.
.RE
.PP
\-p PATCH, \-\-patch PATCH
.RS 4
Refresh (applied) PATCH instead of the top patch\&.
.RE
.PP
\-e, \-\-edit
.RS 4
Invoke an editor for the patch description\&.
.RE
.PP
\-a NOTE, \-\-annotate NOTE
.RS 4
Annotate the patch log entry\&.
.RE
.PP
\-m MESSAGE, \-\-message MESSAGE
.RS 4
Use MESSAGE instead of invoking the editor\&.
.RE
.PP
\-f FILE, \-\-file FILE
.RS 4
Use the contents of FILE instead of invoking the editor\&. (If FILE is "\-", write to stdout\&.)
.RE
.PP
\-\-sign
.RS 4
Add a "Signed\-off\-by:" to the end of the patch\&.
.RE
.PP
\-\-ack
.RS 4
Add an "Acked\-by:" line to the end of the patch\&.
.RE
.PP
\-\-author "NAME "
.RS 4
Set the author details\&.
.RE
.PP
\-\-authname NAME
.RS 4
Set the author name\&.
.RE
.PP
\-\-authemail EMAIL
.RS 4
Set the author email\&.
.RE
.PP
\-\-authdate DATE
.RS 4
Set the author date\&.
.RE
.SH "STGIT"
Part of the StGit suite \- see \fBstg\fR(1)