X-Git-Url: https://git.distorted.org.uk/~mdw/stgit/blobdiff_plain/d3c560baa270240c6f38de9125fad8afb1a2f8c8..5ab0897e67b0203470690a11885b61ca1cb4ab8a:/Documentation/stg.txt diff --git a/Documentation/stg.txt b/Documentation/stg.txt index 5973a6b..eefd6b8 100644 --- a/Documentation/stg.txt +++ b/Documentation/stg.txt @@ -38,6 +38,14 @@ to maintain a 'patch stack' on top of a Git branch: an updated branch, you can take all your patches and apply them on top of the updated branch. + * As you would expect, changing what is below a patch can cause that + patch to no longer apply cleanly -- this can occur when you + reorder patches, rebase patches, or refresh a non-topmost patch. + StGit uses Git's rename-aware three-way merge capability to + automatically fix up what it can; if it still fails, it lets you + manually resolve the conflict just like you would resolve a merge + conflict in Git. + * The patch stack is just some extra metadata attached to regular Git commits, so you can continue to use most Git tools along with StGit. @@ -55,8 +63,8 @@ Tracking branch:: final sequence of patches, and not the messy sequence of edits that produced them. + -Commands of interest in this workflow are e.g. stgsublink:rebase[] and -stgsublink:mail[]. +Commands of interest in this workflow are e.g. linkstgsub:rebase[] and +linkstgsub:mail[]. Development branch:: @@ -69,12 +77,12 @@ Development branch:: immortalized every misstep you made on your way to the right solution. + -Commands of interest in this workflow are e.g. stgsublink:uncommit[], +Commands of interest in this workflow are e.g. linkstgsub:uncommit[], which can be used to move the patch stack base downwards -- i.e., turn Git commits into StGit patches after the fact -- and -stgsublink:commit[], its inverse. +linkstgsub:commit[], its inverse. -For more information, see htmllink:tutorial.html[the tutorial]. +For more information, see link:tutorial.html[the tutorial]. Specifying patches ~~~~~~~~~~~~~~~~~~ @@ -103,7 +111,7 @@ stack base (the commit just below the bottommost patch); so, +abranch:$${base}$$+ is the base of the stack in branch +abranch+. If you need to pass a given StGit reference to a Git command, -stglink:id[] will convert it to a Git commit id for you. +linkstg:id[] will convert it to a Git commit id for you. OPTIONS ------- @@ -136,7 +144,7 @@ include::command-list.txt[] CONFIGURATION MECHANISM ----------------------- -StGit uses the same configuration mechanism as Git. See manlink:git[7] +StGit uses the same configuration mechanism as Git. See linkman:git[7] for more details. TEMPLATES