X-Git-Url: https://git.distorted.org.uk/~mdw/stgit/blobdiff_plain/de7a79c435e5bcbe713c75ec2be1b0221e1d555e..2c1e19f5491eecc562f8a8c237847936b86e4db8:/Documentation/stg.txt

diff --git a/Documentation/stg.txt b/Documentation/stg.txt
index cf28b02..d8f7d01 100644
--- a/Documentation/stg.txt
+++ b/Documentation/stg.txt
@@ -51,6 +51,31 @@ Development branch::
 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
+stglink:push[] or stglink:refresh[] 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,
+stglink:id[] will convert it to a git commit id.
+
 OPTIONS
 -------
 
@@ -80,147 +105,13 @@ description is available in individual command manpages.  Those
 manpages are named 'stg-<command>(1)'.
 endif::backend-docbook[]
 
-Generic commands
-~~~~~~~~~~~~~~~~
-
-User-support commands not touching the repository.
-
-stg help::
-	stgdesc:help[]
-stg version::
-	stgdesc:version[]
-stg copyright::
-	stgdesc:copyright[]
-
-Repository commands
-~~~~~~~~~~~~~~~~~~~
-
-stglink:clone[]::
-	stgdesc:clone[]
-stglink:id[]::
-	stgdesc:id[]
-
-Stack commands
-~~~~~~~~~~~~~~
-
-Stack management
-^^^^^^^^^^^^^^^^
-
-stglink:branch[]::
-	stgdesc:branch[]
-stglink:init[]::
-	stgdesc:init[]
-stglink:clean[]::
-	stgdesc:clean[]
-stglink:pull[]::
-	stgdesc:pull[]
-stglink:rebase[]::
-	stgdesc:rebase[]
-
-stglink:commit[]::
-	stgdesc:commit[]
-stglink:uncommit[]::
-	stgdesc:uncommit[]
-stglink:assimilate[]::
-	stgdesc:assimilate[]
-
-Controlling what patches are applied
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-stglink:series[]::
-	stgdesc:series[]
-stglink:push[]::
-	stgdesc:push[]
-stglink:pop[]::
-	stgdesc:pop[]
-stglink:goto[]::
-	stgdesc:goto[]
-stglink:float[]::
-	stgdesc:float[]
-stglink:bury[]::
-	stgdesc:bury[]
-stglink:applied[]::
-	stgdesc:applied[]
-stglink:unapplied[]::
-	stgdesc:unapplied[]
-stglink:top[]::
-	stgdesc:top[]
-
-stglink:hide[]::
-	stgdesc:hide[]
-stglink:unhide[]::
-	stgdesc:unhide[]
-
-Miscellaneous stack commands
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-stglink:patches[]::
-	stgdesc:patches[]
-
-
-Patch commands
-~~~~~~~~~~~~~~
-
-Patch management
-^^^^^^^^^^^^^^^^
-
-stglink:new[]::
-	stgdesc:new[]
-stglink:delete[]::
-	stgdesc:delete[]
-stglink:rename[]::
-	stgdesc:rename[]
-stglink:log[]::
-	stgdesc:log[]
-
-Controlling patch contents
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-stglink:files[]::
-	stgdesc:files[]
-stglink:show[]::
-	stgdesc:show[]
-stglink:refresh[]::
-	stgdesc:refresh[]
-stglink:fold[]::
-	stgdesc:fold[]
-stglink:pick[]::
-	stgdesc:pick[]
-stglink:sync[]::
-	stgdesc:sync[]
-
-Interaction with the rest of the world
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-stglink:export[]::
-	stgdesc:export[]
-stglink:import[]::
-	stgdesc:import[]
-stglink:mail[]::
-	stgdesc:mail[]
-
-
-Working-copy commands
-~~~~~~~~~~~~~~~~~~~~~
-
-stglink:add[]::
-	stgdesc:add[]
-stglink:rm[]::
-	stgdesc:rm[]
-stglink:cp[]::
-	stgdesc:cp[]
-stglink:status[]::
-	stgdesc:status[]
-stglink:diff[]::
-	stgdesc:diff[]
-stglink:resolved[]::
-	stgdesc:resolved[]
+include::command-list.txt[]
 
 CONFIGURATION MECHANISM
 -----------------------
 
 Starting with 0.12, StGIT uses the same configuration mechanism as
-GIT.  See gitlink:git[7] for more details.
+GIT.  See link:git[7] for more details.
 
 TEMPLATES
 ---------