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

OPTIONS

46       -d, --diff
47           Edit the patch diff.
48
49       -e, --edit
50           Invoke interactive editor.
51
52       --sign
53           Add a "Signed-off-by:" trailer to the end of the message using the
54           committer name and email for the trailer value.
55
56       --sign-by VALUE
57           Add a "Signed-off-by:" trailer with a custom VALUE to the end of
58           the message.
59
60       --ack
61           Add an "Acked-by:" trailer to the end of the message using the
62           commiter name and email for the trailer value.
63
64       --ack-by VALUE
65           Add an "Acked-by:" trailer with a custom VALUE to the end of the
66           message.
67
68       --review
69           Add a "Reviewed-by:" trailer to the end of the message using the
70           commiter name and email for the trailer value.
71
72       --review-by VALUE
73           Add a "Reviewed-by:" trailer with custom VALUE to the end of the
74           message.
75
76       -m MESSAGE, --message MESSAGE
77           Use MESSAGE instead of invoking the editor.
78
79       -f FILE, --file FILE
80           Use the contents of FILE instead of invoking the editor. (If FILE
81           is "-", write to stdout.)
82
83       --save-template FILE
84           Instead of running the command, just write the message template to
85           FILE, and exit. (If FILE is "-", write to stdout.)
86
87           When driving StGit from another program, it is often useful to
88           first call a command with --save-template, then let the user edit
89           the message, and then call the same command with --file.
90
91       --no-verify
92           This option bypasses the commit-msg hook.
93
94       --author "NAME <EMAIL>"
95           Set the author details.
96
97       --authname NAME
98           Set the author name.
99
100       --authemail EMAIL
101           Set the author email.
102
103       --authdate DATE
104           Set the author date.
105
106       -O OPTIONS, --diff-opts OPTIONS
107           Extra options to pass to "git diff".
108
109       -t TREE-ISH, --set-tree TREE-ISH
110           Set the git tree of the patch to TREE-ISH.
111

STGIT

113       Part of the StGit suite - see stg(1)
114
115
116
117StGit 1.5                         01/21/2023                       STG-EDIT(1)