SYNOPSIS

stg [--version | --help] stg [--help <command> | <command> --help] stg <command> [COMMAND OPTIONS] [ARGS]

DESCRIPTION

StGIT (Stacked GIT) is an application providing similar functionality to Quilt (i.e. pushing/popping patches to/from a stack), on top of GIT. These operations are performed using GIT commands and the patches are stored as GIT commit objects, allowing easy merging of the StGIT patches into other repositories using standard GIT functionality.

An StGIT stack is a GIT branch with additional information to help making changes to individual patches you already committed, rather than making changes by adding new commits. It is thus a non-forwarding, or rewinding branch: the old head of the branch is often not reachable as one of the new head's ancestors.

Typical uses of StGIT include:

Tracking branch

Tracking changes from a remote branch, while maintaining local modifications against that branch, possibly with the intent of sending some patches upstream. StGIT assists in preparing and cleaning up patches until they are acceptable upstream, as well as maintaining local patches not meant to be sent upstream.

In such a setup, typically all commits on your branch are StGIT patches; the stack base is the branch point where your changes "fork" off their parent branch.

Development branch

Preparing and testing your commits before publishing them, separating your features from unrelated bugfixes collected while developping.

In such a setup, not all commits on your branch need to be StGIT patches; there may be regular GIT commits below your stack base.

Patches

Many StGIT commands take references to StGIT patches as arguments. Patches in the stack are identified with short names, each of which must be unique in the stack.

Patches in the current stack are just referred to by their name. Some commands allow you to specify a patch in another stack of the repository; this is done by suffixing the patch name with an @ sign followed by the branch name (eg. thispatch@otherbranch).

A number of positions in the stack related to the patch are also accessible through // suffixes. For example, patch//top is equivalent to patch, and patch//bottom refers to the commit below patch (i.e. the patch below, or the stack base if this is the bottom-most patch). Similarly //top.old and //bottom.old refer to the previous version of the patch (before the last stg push(1) or stg refresh(1) operation). When referring to the current patch, its name can be omitted (eg. currentpatch//bottom.old can be abbreviated as bottom.old).

If you need to pass a given StGIT reference to a git command, stg id(1) will convert it to a git commit id.

OPTIONS

The following generic option flags are available. Additional options are available per-command, and documented in the command-specific documentation.

--version

Prints the StGIT suite version that the stg program came from, as well as version of other components used, such as GIT and Python.

--help

Prints the synopsis and a list of all commands. If a git command is given this option will display the specific help for that command.

STGIT COMMANDS

We divide StGIT commands in thematic groups, according to the primary type of object they create or change.

Generic commands

User-support commands not touching the repository.

stg help

print the detailed command usage

stg version

display version information

stg copyright

display copyright information

Repository commands

stg clone(1)

make a local clone of a remote repository

stg id(1)

print the GIT hash value of a StGIT reference

Stack commands

Stack management

stg branch(1)

manage patch stacks

stg init(1)

initialise the current branch for use with StGIT

stg clean(1)

delete the empty patches in the series

stg pull(1)

pull the changes from the remote repository

stg rebase(1)

move the stack base to another point in history

stg commit(1)

permanently store the applied patches into stack base

stg uncommit(1)

turn regular GIT commits into StGIT patches

stg assimilate(1)

StGIT-ify any GIT commits made on top of your StGIT stack

Controlling what patches are applied

stg series(1)

print the patch series

stg push(1)

push patches to the top, even if applied push or pop patches to the given one push one or more patches onto of the stack

stg pop(1)

pop one or more patches from the stack

stg goto(1)

push or pop patches to the given one

stg float(1)

push patches to the top, even if applied

stg sink(1)

send patches deeper down the stack

stg applied(1)

print the applied patches

stg unapplied(1)

print the unapplied patches

stg top(1)

print the name of the top patch

stg hide(1)

hide a patch in the series

stg unhide(1)

unhide a hidden patch in the series

Miscellaneous stack commands

stg patches(1)

show the applied patches modifying a file

Patch commands

Patch management

stg new(1)

create a new patch and make it the topmost one

stg delete(1)

delete the empty patches in the series delete patches

stg rename(1)

rename a patch in the series

stg log(1)

display the patch changelog

Controlling patch contents

stg files(1)

show the files modified by a patch (or the current patch)

stg show(1)

show the applied patches modifying a file show the files modified by a patch (or the current patch) show the commit corresponding to a patch (or the current patch) show the tree diff show the tree status

stg refresh(1)

generate a new commit for the current patch

stg fold(1)

integrate a GNU diff patch into the current patch

stg pick(1)

import a patch from a different branch or a commit object

stg sync(1)

synchronise patches with a branch or a series

Interaction with the rest of the world

stg export(1)

exports patches to a directory

stg import(1)

import a GNU diff file as a new patch import a patch from a different branch or a commit object

stg mail(1)

send a patch or series of patches by e-mail

Working-copy commands

stg add(1)

add files or directories to the repository

stg rm(1)

remove files from the repository

stg cp(1)

copy files inside the repository

stg status(1)

show the tree status

stg diff(1)

show the tree diff

stg resolved(1)

mark a file conflict as solved

CONFIGURATION MECHANISM

Starting with 0.12, StGIT uses the same configuration mechanism as GIT. See git(7) for more details.

TEMPLATES

A number of StGIT commands make use of template files to provide useful default texts to be edited by the user. These <name>.tmpl template files are searched in the following directories:

$GITDIR/
$HOME/.stgit/templates/
/usr/share/stgit/templates/