STG-REFRESH(1)                  StGit Manual                  STG-REFRESH(1)

NAME         top

       stg-refresh - Generate a new commit for the current patch

SYNOPSIS         top

       stg refresh [options] [--] [<files or dirs>]

DESCRIPTION         top

       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 --index or --force 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

       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.

OPTIONS         top

       -u, --update
           Only update the current patch files.

       -i, --index
           Instead of setting the patch top to the current contents of the
           worktree, set it to the current contents of the index.

       -F, --force
           Instead of warning the user when some work has already been
           staged (such as with git add interactive mode) force a full

       -p PATCH, --patch PATCH
           Refresh (applied) PATCH instead of the top patch.

       -e, --edit
           Invoke an editor for the patch description.

       -a NOTE, --annotate NOTE
           Annotate the patch log entry.

       -m MESSAGE, --message MESSAGE
           Use MESSAGE instead of invoking the editor.

       -f FILE, --file FILE
           Use the contents of FILE instead of invoking the editor. (If FILE
           is "-", write to stdout.)

           This option bypasses the commit-msg hook.

           Add a "Signed-off-by:" to the end of the patch.

           Add an "Acked-by:" line to the end of the patch.

           Add a "Reviewed-by:" line to the end of the patch.

       --author "NAME <EMAIL>"
           Set the author details.

       --authname NAME
           Set the author name.

       --authemail EMAIL
           Set the author email.

       --authdate DATE
           Set the author date.

STGIT         top

       Part of the StGit suite - see stg(1)

COLOPHON         top

       This page is part of the stgit (Stacked Git) project.  Information
       about the project can be found at ⟨⟩.
       If you have a bug report for this manual page, see
       ⟨⟩.  This page was obtained from the
       project's upstream Git repository ⟨⟩ on
       2018-10-29.  (At that time, the date of the most recent commit that
       was found in the repository was 2018-02-22.)  If you discover any
       rendering problems in this HTML version of the page, or you believe
       there is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to

StGit                            10/29/2018                   STG-REFRESH(1)

Pages that refer to this page: stg-new(1)