Update show completion to include hidden patches.
[stgit/ydirson.git] / Documentation / stg-sink.txt
blob0f569be4399b8027a4471bf8914006dc6baf8693
1 stg-sink(1)
2 ===========
3 Yann Dirson <ydirson@altern.org>
4 v0.13, April 2007
6 NAME
7 ----
8 stg-sink - stgdesc:sink[]
10 SYNOPSIS
11 --------
12 [verse]
13 'stg' sink [--to=<target>] [--nopush] [<patches>]
15 DESCRIPTION
16 -----------
18 This is the opposite operation of stglink:float[]: move the specified
19 patches down the stack.  It is for example useful to group stable
20 patches near the bottom of the stack, where they are less likely to be
21 impacted by the push of another patch, and from where they can be more
22 easily committed or pushed.
24 If no patch is specified on command-line, the current patch gets sunk.
25 By default patches are sunk to the bottom of the stack, but the
26 '--to' option allows to place them under any applied patch.
28 Sinking internally involves popping all patches (or all patches
29 including <target patch>), then pushing the patches to sink, and then
30 (unless '--nopush' is also given) pushing back into place the
31 formerly-applied patches.
34 OPTIONS
35 -------
37 --to=<TARGET>::
38 -t <TARGET>::
39         Specify a target patch to place the patches below, instead of
40         sinking them to the bottom of the stack.
42 --nopush::
43 -n::
44         Do not push back on the stack the formerly-applied patches.
45         Only the patches to sink are pushed.
47 StGIT
48 -----
49 Part of the StGIT suite - see gitlink:stg[1].