chiark - git - mdw - stgit/blob - Documentation/stg.txt

   1 stg(7)
   2 ======
   3 Yann Dirson <ydirson@altern.org>
   4 v0.12.1, February 2007
   5
   6 NAME
   7 ----
   8 stg - manage stacks of patches using the GIT content tracker
   9
  10 SYNOPSIS
  11 --------
  12 [verse]
  13 'stg' [--version] [--help] <command> [OPTIONS] [ARGS]
  14
  15 DESCRIPTION
  16 -----------
  17
  18 StGIT (Stacked GIT) is an application providing similar functionality
  19 to Quilt (i.e. pushing/popping patches to/from a stack), on top of
  20 GIT. These operations are performed using GIT commands and the patches
  21 are stored as GIT commit objects, allowing easy merging of the StGIT
  22 patches into other repositories using standard GIT functionality.
  23
  24 Typical uses of StGIT include:
  25
  26 Tracking branch::
  27         Maintaining modifications against a remote branch, possibly
  28         with the intent of sending some patches upstream.  StGIT
  29         assists in preparing and cleaning up patches until they are
  30         acceptable upstream, as well as maintaining local patches not
  31         meant to be sent upstream.
  32
  33 Development branch::
  34         Preparing and testing your commits before publishing them,
  35         separating your features from unrelated bugfixes collected
  36         while developping.
  37
  38 OPTIONS
  39 -------
  40
  41 --version::
  42         Prints the StGIT suite version that the 'stg' program came
  43         from, as well as version of other components used, such as GIT
  44         and Python.
  45
  46 --help::
  47         Prints the synopsis and a list of all commands.  If a git
  48         command is given this option will display the specific help
  49         for that command.
  50
  51 STGIT COMMANDS
  52 --------------
  53
  54 We divide StGIT commands in thematic groups, according to the primary
  55 type of object they create or change.
  56
  57 ifdef::backend-docbook[]
  58 Here is a short description of each command. A more detailed
  59 description is available in individual command manpages.  Those
  60 manpages are named 'stg-<command>(1)'.
  61 endif::backend-docbook[]
  62
  63 Generic commands
  64 ~~~~~~~~~~~~~~~~
  65
  66 User-support commands not touching the repository.
  67
  68 stg help::
  69         stgdesc:help[]
  70 stg version::
  71         stgdesc:version[]
  72 stg copyright::
  73         stgdesc:copyright[]
  74
  75 Repository commands
  76 ~~~~~~~~~~~~~~~~~~~
  77
  78 stglink:clone[]::
  79         stgdesc:clone[]
  80 stglink:id[]::
  81         stgdesc:id[]
  82
  83 Stack commands
  84 ~~~~~~~~~~~~~~
  85
  86 Stack management
  87 ^^^^^^^^^^^^^^^^
  88
  89 stglink:branch[]::
  90         stgdesc:branch[]
  91 stglink:init[]::
  92         stgdesc:init[]
  93 stglink:clean[]::
  94         stgdesc:clean[]
  95 stglink:pull[]::
  96         stgdesc:pull[]
  97 stglink:rebase[]::
  98         stgdesc:rebase[]
  99
 100 stglink:commit[]::
 101         stgdesc:commit[]
 102 stglink:uncommit[]::
 103         stgdesc:uncommit[]
 104 stglink:assimilate[]::
 105         stgdesc:assimilate[]
 106
 107 Controlling what patches are applied
 108 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 109
 110 stglink:series[]::
 111         stgdesc:series[]
 112 stglink:push[]::
 113         stgdesc:push[]
 114 stglink:pop[]::
 115         stgdesc:pop[]
 116 stglink:goto[]::
 117         stgdesc:goto[]
 118 stglink:float[]::
 119         stgdesc:float[]
 120 stglink:applied[]::
 121         stgdesc:applied[]
 122 stglink:unapplied[]::
 123         stgdesc:unapplied[]
 124 stglink:top[]::
 125         stgdesc:top[]
 126
 127 stglink:hide[]::
 128         stgdesc:hide[]
 129 stglink:unhide[]::
 130         stgdesc:unhide[]
 131
 132 Miscellaneous stack commands
 133 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 134
 135 stglink:patches[]::
 136         stgdesc:patches[]
 137
 138
 139 Patch commands
 140 ~~~~~~~~~~~~~~
 141
 142 Patch management
 143 ^^^^^^^^^^^^^^^^
 144
 145 stglink:new[]::
 146         stgdesc:new[]
 147 stglink:delete[]::
 148         stgdesc:delete[]
 149 stglink:rename[]::
 150         stgdesc:rename[]
 151 stglink:log[]::
 152         stgdesc:log[]
 153
 154 Controlling patch contents
 155 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 156
 157 stglink:files[]::
 158         stgdesc:files[]
 159 stglink:show[]::
 160         stgdesc:show[]
 161 stglink:refresh[]::
 162         stgdesc:refresh[]
 163 stglink:fold[]::
 164         stgdesc:fold[]
 165 stglink:pick[]::
 166         stgdesc:pick[]
 167 stglink:sync[]::
 168         stgdesc:sync[]
 169
 170 Interaction with the rest of the world
 171 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 172
 173 stglink:export[]::
 174         stgdesc:export[]
 175 stglink:import[]::
 176         stgdesc:import[]
 177 stglink:mail[]::
 178         stgdesc:mail[]
 179
 180
 181 Working-copy commands
 182 ~~~~~~~~~~~~~~~~~~~~~
 183
 184 stglink:add[]::
 185         stgdesc:add[]
 186 stglink:rm[]::
 187         stgdesc:rm[]
 188 stglink:cp[]::
 189         stgdesc:cp[]
 190 stglink:status[]::
 191         stgdesc:status[]
 192 stglink:diff[]::
 193         stgdesc:diff[]
 194 stglink:resolved[]::
 195         stgdesc:resolved[]
 196
 197 CONFIGURATION MECHANISM
 198 -----------------------
 199
 200 Starting with 0.12, StGIT uses the same configuration mechanism as
 201 GIT.  See gitlink:git[7] for more details.
 202
 203 TEMPLATES
 204 ---------
 205
 206 A number of StGIT commands make use of template files to provide
 207 useful default texts to be edited by the user.  These '<name>.tmpl'
 208 template files are searched in the following directories:
 209
 210         $GITDIR/
 211         $HOME/.stgit/templates/
 212         /usr/share/stgit/templates/