1STG-REFRESH(1) StGit Manual STG-REFRESH(1)
2
6 stg-refresh - Generate a new commit for the current patch
7
9 stg refresh [options] [--] [<files or dirs>]
10
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 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 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 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 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 Additionally, the --spill option resets the topmost patch, emptying the
37 patch while leaving the patch’s changes intact in the worktree.
38
40 -u, --update
41 Only update the current patch files.
42 -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 -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 -p PATCH, --patch PATCH
52 Refresh (applied) PATCH instead of the top patch.
53 -e, --edit
55 Invoke an editor for the patch description.
56 -d, --diff
58 Show diff when editing patch description.
59 -a NOTE, --annotate NOTE
61 Annotate the patch log entry.
62 -s, --submodules
64 Include submodules when refreshing patch contents.
65 --no-submodules
67 Exclude submodules when refreshing patch contents.
68 --spill
70 Spill patch content to worktree and index, erasing patch content..
71 -m MESSAGE, --message MESSAGE
73 Use MESSAGE instead of invoking the editor.
74 -f FILE, --file FILE
76 Use the contents of FILE instead of invoking the editor. (If FILE
77 is "-", write to stdout.)
78 --no-verify
80 This option bypasses the commit-msg hook.
81 --sign
83 Add a "Signed-off-by:" trailer to the end of the message using the
84 committer name and email for the trailer value.
85 --sign-by VALUE
87 Add a "Signed-off-by:" trailer with a custom VALUE to the end of
88 the message.
89 --ack
91 Add an "Acked-by:" trailer to the end of the message using the
92 commiter name and email for the trailer value.
93 --ack-by VALUE
95 Add an "Acked-by:" trailer with a custom VALUE to the end of the
96 message.
97 --review
99 Add a "Reviewed-by:" trailer to the end of the message using the
100 commiter name and email for the trailer value.
101 --review-by VALUE
103 Add a "Reviewed-by:" trailer with custom VALUE to the end of the
104 message.
105 --author "NAME <EMAIL>"
107 Set the author details.
108 --authname NAME
110 Set the author name.
111 --authemail EMAIL
113 Set the author email.
114 --authdate DATE
116 Set the author date.
117 -O OPTIONS, --diff-opts OPTIONS
119 Extra options to pass to "git diff".
120
122 Part of the StGit suite - see stg(1)
123StGit 1.4 01/22/2022 STG-REFRESH(1)