# stg-edit

## NAME



           stg-edit - Edit a patch
    


## SYNOPSIS



           _stg edit_ [OPTIONS] [patch]
    


## DESCRIPTION



           Edit a patch. Various aspects of a patch may be edited, including
           the message, author, patch name, or even the patch’s diff.
    
           By default, the topmost patch is edited.
    
           With no options or when _--edit_ is specified, the patch details are
           edited interactively. Alternatively, command line options may be
           used to modify the patch non-interactively.
    
           The _--diff_ option causes the patch’s diff to be appended to the
           patch description when editing interactively. This diff may be
           edited interactively (or just used as a reference when editing the
           patch’s message). The StGit attempts to apply the modified diff to
           the patch’s parent tree. If the updated diff does not apply, no
           changes are made to the patch and the edited patch is saved to a
           file which may be corrected and then fed-back into **stg edit**
           **--file**.
    


## OPTIONS



           -e, --edit
               Invoke editor for patch description
    
           -d, --diff
               Show diff when editing patch description
    
           -m <message>, --message=<message>
               Use message instead of invoking the editor
    
           -f <path>, --file=<path>
               Use the contents of file instead of invoking the editor. Use
               "-" to read from stdin.
    
           --no-verify
               Disable commit-msg hook
    
           -s[=<value>], --signoff[=<value>]
               Add "Signed-off-by" message trailer.
    
               The value is optional and defaults to the committer name and
               email. This option may be provided multiple times.
    
           --ack[=<value>]
               Add "Acked-by" message trailer.
    
               The value is optional and defaults to the committer’s name and
               email. This option may be provided multiple times.
    
           --review[=<value>]
               Add "Reviewed-by" message trailer.
    
               The value is optional and defaults to the committer’s name and
               email. This option may be provided multiple times.
    
           --author=<name-and-email>
               Set the author "name <email>"
    
           --authname=<name>
               Set the author name
    
           --authemail=<email>
               Set the author email
    
           --authdate=<date>
               Set the date the patch was authored.
    
               Use "now" to use the current time and date.
    
           --committer-date-is-author-date
               Instead of using the current time as the committer date, use
               the author date of the commit as the committer date.
    
           --save-template=<file>
               Instead of running the command, just write the patch
               description to FILE, and exit. (If FILE is "-", write to
               stdout.)
    
               When driving StGit from another program, it may be useful to
               first call a command with _--save-template_ , then let the user
               edit the message, and then call the same command with _--file_.
    
           -t <treeish>, --set-tree=<treeish>
               Set the patch’s git tree to the specified treeish without
               changing the tree of any other patches. When used on the top
               patch, the index and work tree will be updated to match the
               new tree. This low-level option is primarily meant to be used
               by tools built on top of StGit, such as the Emacs mode. See
               also the _--set-tree_ flag of stg-push(1).
    


## STGIT



           Part of the StGit suite - see stg(1)
    


* * *