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

NAME

6       stg-edit - Edit a patch description or diff
7

SYNOPSIS

9       stg edit [options] [--] [<patch>]
10

DESCRIPTION

12       Edit the description and author information of the given patch (or the
13       current patch if no patch name was given). With --diff, also edit the
14       diff.
15
16       The editor is invoked with the following contents:
17
18
19           From: A U Thor <author@example.com>
20           Date: creation date
21
22           Patch description
23
24       If --diff was specified, the diff appears at the bottom, after a
25       separator:
26
27
28           ---
29
30           Diff text
31
32       Command-line options can be used to modify specific information without
33       invoking the editor. (With the --edit option, the editor is invoked
34       even if such command-line options are given.)
35
36       If the patch diff is edited but does not apply, no changes are made to
37       the patch at all. The edited patch is saved to a file which you can
38       feed to "stg edit --file", once you have made sure it does apply.
39
40       With --set-tree you set the git tree of the patch to the specified
41       TREE-ISH without changing the tree of any other patches. When used on
42       the top patch, the index and work tree will be updated to match the
43       tree. This low-level option is primarily meant to be used by tools
44       built on top of StGit, such as the Emacs mode. See also the --set-tree
45       flag of stg push.
46

OPTIONS

48       -d, --diff
49           Edit the patch diff.
50
51       -e, --edit
52           Invoke interactive editor.
53
54       --sign
55           Add a "Signed-off-by:" to the end of the patch.
56
57       --ack
58           Add an "Acked-by:" line to the end of the patch.
59
60       --review
61           Add a "Reviewed-by:" line to the end of the patch.
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       --save-template FILE
71           Instead of running the command, just write the message template to
72           FILE, and exit. (If FILE is "-", write to stdout.)
73
74           When driving StGit from another program, it is often useful to
75           first call a command with --save-template, then let the user edit
76           the message, and then call the same command with --file.
77
78       --no-verify
79           This option bypasses the commit-msg hook.
80
81       --author "NAME <EMAIL>"
82           Set the author details.
83
84       --authname NAME
85           Set the author name.
86
87       --authemail EMAIL
88           Set the author email.
89
90       --authdate DATE
91           Set the author date.
92
93       -O OPTIONS, --diff-opts OPTIONS
94           Extra options to pass to "git diff".
95
96       -t TREE-ISH, --set-tree TREE-ISH
97           Set the git tree of the patch to TREE-ISH.
98

STGIT

100       Part of the StGit suite - see stg(1)
101
102
103
104
105StGit                             01/31/2020                       STG-EDIT(1)