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

OPTIONS

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

STGIT

95       Part of the StGit suite - see stg(1)
96
97
98
99StGit 0.23                        01/27/2021                    STG-REFRESH(1)
Impressum