From: Karl Hasselström Date: Fri, 13 Mar 2009 02:57:20 +0000 (+0100) Subject: stg squash: Improve documentation X-Git-Tag: v0.15-rc1~43 X-Git-Url: https://git.distorted.org.uk/~mdw/stgit/commitdiff_plain/0d1d5574390c461e9ed2db52cb32fa7962ecce42 stg squash: Improve documentation In particular, mention how the order of the given patches matter, and exactly what happens in case of conflict. Signed-off-by: Karl Hasselström --- diff --git a/stgit/commands/squash.py b/stgit/commands/squash.py index f499037..d0be466 100644 --- a/stgit/commands/squash.py +++ b/stgit/commands/squash.py @@ -28,11 +28,23 @@ kind = 'stack' usage = ['[options] '] description = """ Squash two or more patches, creating one big patch that contains all -their changes. +their changes. In more detail: -If there are conflicts when reordering the patches to match the order -you specify, you will have to resolve them manually just as if you had -done a sequence of pushes and pops yourself.""" + 1. Pop all the given patches, plus any other patches on top of them. + + 2. Push the given patches in the order they were given on the + command line. + + 3. Squash the given patches into one big patch. + + 4. Allow the user to edit the commit message of the new patch + interactively. + + 5. Push the other patches that were popped in step (1). + +Conflicts can occur whenever we push a patch; that is, in step (2) and +(5). If there are conflicts, the command will stop so that you can +resolve them.""" args = [argparse.patch_range(argparse.applied_patches, argparse.unapplied_patches)]