# stg-new

## NAME



           stg-new - Create a new patch at top of the stack
    


## SYNOPSIS



           _stg new_ [OPTIONS] [patchname] [-- <path>...]
           _stg new_ [OPTIONS] [--name <patchname>] [-- <path>...]
    


## DESCRIPTION



           Create a new, empty patch on the current stack. The new patch is
           created on top of the currently applied patches, and is made the
           new top of the stack. Uncommitted changes in the work tree are not
           included in the patch — that is handled by stg-refresh.
    
           The given patch name must be unique in the stack. If no name is
           given, one is generated from the first line of the patch’s commit
           message.
    
           Patch names follow the rules for Git references with the
           additional constraint that patch names may not contain the _/_
           character. See git-check-ref-format(1) for details.
    
           Patch names may start with a leading _-_. When specifying such a
           patch name on the command line, the leading _-_ may be escaped with
           a single backslash as in _\-patch-name_ to disambiguate the patch
           name from command line options.
    
           An editor will be launched to edit the commit message to be used
           for the patch, unless the _--message_ flag already specified one.
           The _patchdescr.tmpl_ template file (if available) is used to
           pre-fill the editor.
    


## OPTIONS



           -n <name>, --name=<name>
               Alternative to the [patchname] argument for specifying the
               name of the new patch. This option allows the patch name to
               start with an unescaped leading _-_.
    
           -r, --refresh
               Refresh the new patch with changes from work tree. New patches
               are empty by default, but with this option the new patch will
               capture outstanding changes in the work tree as if
               stg-refresh(1) was run. Use _--index_ to refresh from the index
               instead of the work tree.
    
           -i, --index
               Instead of refreshing the patch with the current contents of
               the worktree, use the current contents of the index.
    
           -F, --force
               Force refresh with staged and unstaged changes.
    
               By default, if there are staged changes in the index along
               with unstaged changes in the work tree, the command will
               abort. This option forces the command to proceed using both
               the staged and unstaged changes.
    
           --submodules
               Include submodules in patch content
    
           --no-submodules
               Exclude submodules in patch content
    
           -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_.
    


## STGIT



           Part of the StGit suite - see stg(1)
    


* * *