[PATCH] git-am.txt: advertise 'git am --abort' instead of 'rm .git/rebase-apply'

[PATCH] git-am.txt: advertise 'git am --abort' instead of 'rm .git/rebase-apply'

[SZEDER Gábor]

'git am --abort' is around for quite a long time now, and users should
normally not poke around inside the .git directory, yet the
documentation of 'git am' still recommends the following:

  ... if you decide to start over from scratch,
  run `rm -f -r .git/rebase-apply` ...

Suggest 'git am --abort' instead.

It's not quite the same as the original, because 'git am --abort' will
restore the original branch, while simply removing '.git/rebase-apply'
won't, but that's rather a thinko in the original wording, because
that won't actually "start over _from scratch_".

Signed-off-by: SZEDER Gábor <szeder@ira.uka.de>
---
 Documentation/git-am.txt |    6 +++---
 1 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt
index 621b720..03fb214 100644
--- a/Documentation/git-am.txt
+++ b/Documentation/git-am.txt
@@ -173,9 +173,9 @@ aborts in the middle.  You can recover from this in one of two ways:
   the index file to bring it into a state that the patch should
   have produced.  Then run the command with the '--resolved' option.
 
-The command refuses to process new mailboxes while the `.git/rebase-apply`
-directory exists, so if you decide to start over from scratch,
-run `rm -f -r .git/rebase-apply` before running the command with mailbox
+The command refuses to process new mailboxes before the current
+operation isn't finished, so if you decide to start over from scratch,
+run `git am --abort` before running the command with mailbox
 names.
 
 Before any patches are applied, ORIG_HEAD is set to the tip of the
-- 
1.7.4.1.372.g95585

Re: [PATCH] git-am.txt: advertise 'git am --abort' instead of 'rm .git/rebase-apply'

[Junio C Hamano]

Sensible; thanks.

Re: [PATCH] git-am.txt: advertise 'git am --abort' instead of 'rm .git/rebase-apply'

[Jeff King]

On Tue, Mar 22, 2011 at 07:42:25PM +0100, SZEDER Gábor wrote:

> -The command refuses to process new mailboxes while the `.git/rebase-apply`
> -directory exists, so if you decide to start over from scratch,
> -run `rm -f -r .git/rebase-apply` before running the command with mailbox
> +The command refuses to process new mailboxes before the current
> +operation isn't finished, so if you decide to start over from scratch,
> +run `git am --abort` before running the command with mailbox
>  names.

Grammar: it should be "...before the current operation is finished".

-Peff

Re: [PATCH] git-am.txt: advertise 'git am --abort' instead of 'rm .git/rebase-apply'

[SZEDER Gábor]

On Tue, Mar 22, 2011 at 03:17:08PM -0400, Jeff King wrote:
> On Tue, Mar 22, 2011 at 07:42:25PM +0100, SZEDER Gábor wrote:
> 
> > -The command refuses to process new mailboxes while the `.git/rebase-apply`
> > -directory exists, so if you decide to start over from scratch,
> > -run `rm -f -r .git/rebase-apply` before running the command with mailbox
> > +The command refuses to process new mailboxes before the current
> > +operation isn't finished, so if you decide to start over from scratch,
> > +run `git am --abort` before running the command with mailbox
> >  names.
> 
> Grammar: it should be "...before the current operation is finished".

Thanks; I almost wrote after the '---' that I'm not quite happy with
the wording of the first part of the sentence, but I just couldn't see
why...  at least now I know ;)


Best,
Gábor