stg-edit(1) — Linux manual page

NAME \| SYNOPSIS \| DESCRIPTION \| OPTIONS \| STGIT \| COLOPHON

STG-EDIT(1)                   StGit Manual                   STG-EDIT(1)

NAME top

       stg-edit - Edit a patch description or diff

SYNOPSIS top

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

DESCRIPTION top

       Edit the description and author information of the given patch
       (or the current patch if no patch name was given). With --diff,
       also edit the diff.

       The editor is invoked with the following contents:

           From: A U Thor <author@example.com>
           Date: creation date

           Patch description

       If --diff was specified, the diff appears at the bottom, after a
       separator:

           ---

           Diff text

       Command-line options can be used to modify specific information
       without invoking the editor. (With the --edit option, the editor
       is invoked even if such command-line options are given.)

       If the patch diff is edited but does not apply, no changes are
       made to the patch at all. The edited patch is saved to a file
       which you can feed to "stg edit --file", once you have made sure
       it does apply.

       With --set-tree you set the git tree of the patch to the
       specified TREE-ISH 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 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.

OPTIONS top

       -d, --diff
           Edit the patch diff.

       -e, --edit
           Invoke interactive editor.

       --sign
           Add a "Signed-off-by:" trailer to the end of the message
           using the committer name and email for the trailer value.

       --sign-by VALUE
           Add a "Signed-off-by:" trailer with a custom VALUE to the end
           of the message.

       --ack
           Add an "Acked-by:" trailer to the end of the message using
           the commiter name and email for the trailer value.

       --ack-by VALUE
           Add an "Acked-by:" trailer with a custom VALUE to the end of
           the message.

       --review
           Add a "Reviewed-by:" trailer to the end of the message using
           the commiter name and email for the trailer value.

       --review-by VALUE
           Add a "Reviewed-by:" trailer with custom VALUE to the end of
           the message.

       -m MESSAGE, --message MESSAGE
           Use MESSAGE instead of invoking the editor.

       -f FILE, --file FILE
           Use the contents of FILE instead of invoking the editor. (If
           FILE is "-", write to stdout.)

       --save-template FILE
           Instead of running the command, just write the message
           template to FILE, and exit. (If FILE is "-", write to
           stdout.)

           When driving StGit from another program, it is often useful
           to first call a command with --save-template, then let the
           user edit the message, and then call the same command with
           --file.

       --no-verify
           This option bypasses the commit-msg hook.

       --author "NAME <EMAIL>"
           Set the author details.

       --authname NAME
           Set the author name.

       --authemail EMAIL
           Set the author email.

       --authdate DATE
           Set the author date.

       -O OPTIONS, --diff-opts OPTIONS
           Extra options to pass to "git diff".

       -t TREE-ISH, --set-tree TREE-ISH
           Set the git tree of the patch to TREE-ISH.

STGIT top

       Part of the StGit suite - see stg(1)

COLOPHON top

       This page is part of the stgit (Stacked Git) project.
       Information about the project can be found at 
       ⟨http://www.procode.org/stgit/⟩.  If you have a bug report for
       this manual page, see ⟨http://www.procode.org/stgit/⟩.  This page
       was obtained from the project's upstream Git repository
       ⟨http://repo.or.cz/stgit.git⟩ on 2022-12-17.  (At that time, the
       date of the most recent commit that was found in the repository
       was 2022-01-07.)  If you discover any rendering problems in this
       HTML version of the page, or you believe there is a better or
       more up-to-date source for the page, or you have corrections or
       improvements to the information in this COLOPHON (which is not
       part of the original manual page), send a mail to
       man-pages@man7.org

StGit 1.4.dev34+g8254ffb       12/17/2022                    STG-EDIT(1)

Pages that refer to this page: stg(1)