1STG-REFRESH(1)                   StGit Manual                   STG-REFRESH(1)
2
3
4

NAME

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

SYNOPSIS

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

DESCRIPTION

12       Include the latest work tree and index changes in the current patch.
13       This command generates a new git commit object for the patch; the old
14       commit is no longer visible.
15
16       Refresh will warn if the index is dirty, and require use of either the
17       --index or --force options to override this check. This is to prevent
18       accidental full refresh when only some changes were staged using git
19       add interative mode.
20
21       You may optionally list one or more files or directories relative to
22       the current working directory; if you do, only matching files will be
23       updated.
24
25       Behind the scenes, stg refresh first creates a new temporary patch with
26       your updates, and then merges that patch into the patch you asked to
27       have refreshed. If you asked to refresh a patch other than the topmost
28       patch, there can be conflicts; in that case, the temporary patch will
29       be left for you to take care of, for example with stg squash.
30
31       The creation of the temporary patch is recorded in a separate entry in
32       the patch stack log; this means that one undo step will undo the merge
33       between the other patch and the temp patch, and two undo steps will
34       additionally get rid of the temp patch.
35
36       Additionally, the --spill option resets the topmost patch, emptying the
37       patch while leaving the patch’s changes intact in the worktree.
38

OPTIONS

40       -u, --update
41           Only update the current patch files.
42
43       -i, --index
44           Instead of setting the patch top to the current contents of the
45           worktree, set it to the current contents of the index.
46
47       -F, --force
48           Instead of warning the user when some work has already been staged
49           (such as with git add interactive mode) force a full refresh.
50
51       -p PATCH, --patch PATCH
52           Refresh (applied) PATCH instead of the top patch.
53
54       -e, --edit
55           Invoke an editor for the patch description.
56
57       -d, --diff
58           Show diff when editing patch description.
59
60       -a NOTE, --annotate NOTE
61           Annotate the patch log entry.
62
63       -s, --submodules
64           Include submodules when refreshing patch contents.
65
66       --no-submodules
67           Exclude submodules when refreshing patch contents.
68
69       --spill
70           Spill patch content to worktree and index, erasing patch content..
71
72       -m MESSAGE, --message MESSAGE
73           Use MESSAGE instead of invoking the editor.
74
75       -f FILE, --file FILE
76           Use the contents of FILE instead of invoking the editor. (If FILE
77           is "-", write to stdout.)
78
79       --no-verify
80           This option bypasses the commit-msg hook.
81
82       --sign
83           Add a "Signed-off-by:" to the end of the patch.
84
85       --ack
86           Add an "Acked-by:" line to the end of the patch.
87
88       --review
89           Add a "Reviewed-by:" line to the end of the patch.
90
91       --author "NAME <EMAIL>"
92           Set the author details.
93
94       --authname NAME
95           Set the author name.
96
97       --authemail EMAIL
98           Set the author email.
99
100       --authdate DATE
101           Set the author date.
102
103       -O OPTIONS, --diff-opts OPTIONS
104           Extra options to pass to "git diff".
105

STGIT

107       Part of the StGit suite - see stg(1)
108
109
110
111StGit 1.1                         07/23/2021                    STG-REFRESH(1)