Section 1: user commands and tools
NAME stg-push – Push one or more patches onto the stack SYNOPSIS stg push[options][–][<patch1>][<patch2>][<patch3>..<patch4>] DESCRIPTION Push one or more patches (defaulting to the first unapplied one) onto the stack. The push operation allows patch reordering by commuting them with the three-way merge algorithm. If there are conflicts while pushing a patch, those conflicts are written…
NAME stg-pull – Pull changes from a remote repository SYNOPSIS stg pull[options][–][<repository>] DESCRIPTION Pull the latest changes from the given remote repository (defaulting to branch.<name>.remote, or origin if not set). This command works by popping all the patches from the stack, pulling the changes in the parent repository, setting the base of the stack to…
NAME stg-publish – Push the stack changes to a merge-friendly branch SYNOPSIS stg publish[options][–][branch] DESCRIPTION This command commits a set of changes on a separate (called public) branch based on the modifications of the given or current stack. The history of the public branch is not re-written, making it merge-friendly and feasible for publishing. The…
NAME stg-prev – Print the name of the previous patch SYNOPSIS stg prev DESCRIPTION Print the name of the previous patch. OPTIONS -b BRANCH, –branch BRANCH Use BRANCH instead of the default branch. STGIT Part of the StGit suite – see stg(1) Index
NAME stg-pop – Pop one or more patches from the stack SYNOPSIS stg pop[options][–][<patch1>][<patch2>][<patch3>..<patch4>] DESCRIPTION Pop the topmost patch or a range of patches from the stack. The command fails if there are conflicts or local changes (and –keep was not specified). A series of pop and push operations are performed so that only the…
NAME stg-pick – Import a patch from a different branch or a commit object SYNOPSIS stg pick[options][–]([<patch1>][<patch2>][<patch3>..<patch4>]) | <commit> DESCRIPTION Import one or more patches from a different branch or a commit object into the current series. By default, the name of the imported patch is used as the name of the current patch. It…
NAME stg-patches – Show the applied patches modifying a file SYNOPSIS stg patches[options][–][ < files or dirs > ] DESCRIPTION Show the applied patches modifying the given files. Without arguments, it shows the patches affected by the local tree modifications. The –diff option also lists the patch log and the diff for the given files….
NAME stg-next – Print the name of the next patch SYNOPSIS stg next DESCRIPTION Print the name of the next patch. OPTIONS -b BRANCH, –branch BRANCH Use BRANCH instead of the default branch. STGIT Part of the StGit suite – see stg(1) Index
NAME stg-new – Create a new, empty patch SYNOPSIS stg new[options][–][<name>] 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 —…
NAME stg-mail – Send a patch or series of patches by e-mail SYNOPSIS stg mail[options][–][<patch1>][<patch2>][<patch3>..<patch4>] DESCRIPTION Send a patch or a range of patches by e-mail using the SMTP server specified by the stgit.smtpserver configuration option, or the –smtp-server command line option. This option can also be an absolute path to sendmail followed by command…
NAME stg-log – Display the patch changelog SYNOPSIS stg log[options][–][<patches>] DESCRIPTION List the history of the patch stack: the stack log. If one or more patch names are given, limit the list to the log entries that touch the named patches. "stg undo" and "stg redo" let you step back and forth in the patch…
NAME stg-init – Initialise the current branch for use with StGIT SYNOPSIS stg init DESCRIPTION Initialise the current git branch to be used as an StGIT stack. The branch (and the git repository it is in) must already exist and contain at least one commit. STGIT Part of the StGit suite – see stg(1) Index
NAME stg-import – Import a GNU diff file as a new patch SYNOPSIS stg import[options][–][<file> | <url>] DESCRIPTION Create a new patch and apply the given GNU diff file (or the standard input). By default, the file name is used as the patch name but this can be overridden with the –name option. The patch…
NAME stg-id – Print the git hash value of a StGit reference SYNOPSIS stg id[options][–][<id>] DESCRIPTION Print the SHA1 value of a Git id (defaulting to HEAD). In addition to the standard Git id’s like heads and tags, this command also accepts [<branch>:]<patch> for the id of a patch, [<branch>:]{base} for the base of the…
NAME stg-hide – Hide a patch in the series SYNOPSIS stg hide[options][–]<patch – range> DESCRIPTION Hide a range of unapplied patches so that they are no longer shown in the plain series command output. OPTIONS -b BRANCH, –branch BRANCH Use BRANCH instead of the default branch. STGIT Part of the StGit suite – see stg(1)…
NAME stg-goto – Push or pop patches to the given one SYNOPSIS stg goto[options][–]<patch – name> DESCRIPTION Push/pop patches to/from the stack until the one given on the command line becomes current. OPTIONS -k, –keep Keep the local changes. -m, –merged Check for patches merged upstream. STGIT Part of the StGit suite – see stg(1)…
NAME stg-fold – Integrate a GNU diff patch into the current patch SYNOPSIS stg fold[options][–][<file>] DESCRIPTION Apply the given GNU diff file (or the standard input) onto the top of the current patch. With the –threeway option, the patch is applied onto the bottom of the current patch and a three-way merge is performed with…
NAME stg-float – Push patches to the top, even if applied SYNOPSIS stg float[–]<patches> stg float – s<series> DESCRIPTION Push a patch or a range of patches to the top even if applied. The necessary pop and push operations will be performed to accomplish this. The –series option can be used to rearrange the (top)…
NAME stg-files – Show the files modified by a patch (or the current patch) SYNOPSIS stg files[options][–][[<branch>:]<patch>] DESCRIPTION List the files modified by the given patch (defaulting to the current one). Passing the –stat option shows the diff statistics for the given patch. Note that this command doesn’t show the files modified in the working…
NAME stg-export – Export patches to a directory SYNOPSIS stg export[options][–][<patch1>][<patch2>][<patch3>..<patch4>] DESCRIPTION Export a range of applied patches to a given directory (defaults to patches-<branch>) in a standard unified GNU diff format. A template file (defaulting to .git/patchexport.tmpl or ~/.stgit/templates/patchexport.tmpl or /usr/share/stgit/templates/patchexport.tmpl) can be used for the patch format. The following variables are supported in…