git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
* [PATCH] am: replace uses of --resolved with --continue
@ 2013-06-26 20:06 Kevin Bracey
  2013-06-27  8:33 ` John Keeping
  0 siblings, 1 reply; 3+ messages in thread
From: Kevin Bracey @ 2013-06-26 20:06 UTC (permalink / raw)
  To: git; +Cc: Jeff King, Kevin Bracey

git am was previously modified to provide --continue for consistency
with rebase, merge etc, and the documentation changed to showing
--continue as the primary form.

Complete the work by replacing remaining uses of --resolved by
--continue, most notably in suggested command reminders.

Signed-off-by: Kevin Bracey <kevin@bracey.fi>
---
 Documentation/git-am.txt      | 4 ++--
 Documentation/user-manual.txt | 2 +-
 git-am.sh                     | 8 ++++----
 t/t7512-status-help.sh        | 4 ++--
 wt-status.c                   | 2 +-
 5 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt
index 5bbe7b6..54d8461 100644
--- a/Documentation/git-am.txt
+++ b/Documentation/git-am.txt
@@ -132,7 +132,7 @@ default.   You can use `--no-utf8` to override this.
 --resolvemsg=<msg>::
 	When a patch failure occurs, <msg> will be printed
 	to the screen before exiting.  This overrides the
-	standard message informing you to use `--resolved`
+	standard message informing you to use `--continue`
 	or `--skip` to handle the failure.  This is solely
 	for internal use between 'git rebase' and 'git am'.
 
@@ -176,7 +176,7 @@ aborts in the middle.  You can recover from this in one of two ways:
 
 . hand resolve the conflict in the working directory, and update
   the index file to bring it into a state that the patch should
-  have produced.  Then run the command with the '--resolved' option.
+  have produced.  Then run the command with the '--continue' option.
 
 The command refuses to process new mailboxes until the current
 operation is finished, so if you decide to start over from scratch,
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index e831cc2..8218cf9 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -1835,7 +1835,7 @@ Once the index is updated with the results of the conflict
 resolution, instead of creating a new commit, just run
 
 -------------------------------------------------
-$ git am --resolved
+$ git am --continue
 -------------------------------------------------
 
 and Git will create the commit for you and continue applying the
diff --git a/git-am.sh b/git-am.sh
index 9f44509..7ea40fe 100755
--- a/git-am.sh
+++ b/git-am.sh
@@ -6,7 +6,7 @@ SUBDIRECTORY_OK=Yes
 OPTIONS_KEEPDASHDASH=
 OPTIONS_SPEC="\
 git am [options] [(<mbox>|<Maildir>)...]
-git am [options] (--resolved | --skip | --abort)
+git am [options] (--continue | --skip | --abort)
 --
 i,interactive   run interactively
 b,binary*       (historical option -- no-op)
@@ -102,7 +102,7 @@ stop_here_user_resolve () {
 	    printf '%s\n' "$resolvemsg"
 	    stop_here $1
     fi
-    eval_gettextln "When you have resolved this problem, run \"\$cmdline --resolved\".
+    eval_gettextln "When you have resolved this problem, run \"\$cmdline --continue\".
 If you prefer to skip this patch, run \"\$cmdline --skip\" instead.
 To restore the original branch and stop patching, run \"\$cmdline --abort\"."
 
@@ -523,7 +523,7 @@ Use \"git am --abort\" to remove it.")"
 		esac
 	fi
 
-	# Make sure we are not given --skip, --resolved, nor --abort
+	# Make sure we are not given --skip, --continue, nor --abort
 	test "$skip$resolved$abort" = "" ||
 		die "$(gettext "Resolve operation not in progress, we are not resuming.")"
 
@@ -670,7 +670,7 @@ do
 	#  - patch is the patch body.
 	#
 	# When we are resuming, these files are either already prepared
-	# by the user, or the user can tell us to do so by --resolved flag.
+	# by the user, or the user can tell us to do so by --continue flag.
 	case "$resume" in
 	'')
 		if test -f "$dotest/rebasing"
diff --git a/t/t7512-status-help.sh b/t/t7512-status-help.sh
index 4f09bec..bd8aab0 100755
--- a/t/t7512-status-help.sh
+++ b/t/t7512-status-help.sh
@@ -510,7 +510,7 @@ test_expect_success 'status in an am session: file already exists' '
 	cat >expected <<-\EOF &&
 	# On branch am_already_exists
 	# You are in the middle of an am session.
-	#   (fix conflicts and then run "git am --resolved")
+	#   (fix conflicts and then run "git am --continue")
 	#   (use "git am --skip" to skip this patch)
 	#   (use "git am --abort" to restore the original branch)
 	#
@@ -532,7 +532,7 @@ test_expect_success 'status in an am session: file does not exist' '
 	cat >expected <<-\EOF &&
 	# On branch am_not_exists
 	# You are in the middle of an am session.
-	#   (fix conflicts and then run "git am --resolved")
+	#   (fix conflicts and then run "git am --continue")
 	#   (use "git am --skip" to skip this patch)
 	#   (use "git am --abort" to restore the original branch)
 	#
diff --git a/wt-status.c b/wt-status.c
index 438a40d..b191c65 100644
--- a/wt-status.c
+++ b/wt-status.c
@@ -826,7 +826,7 @@ static void show_am_in_progress(struct wt_status *s,
 	if (advice_status_hints) {
 		if (!state->am_empty_patch)
 			status_printf_ln(s, color,
-				_("  (fix conflicts and then run \"git am --resolved\")"));
+				_("  (fix conflicts and then run \"git am --continue\")"));
 		status_printf_ln(s, color,
 			_("  (use \"git am --skip\" to skip this patch)"));
 		status_printf_ln(s, color,
-- 
1.8.3.rc0.28.g4b02ef5

^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [PATCH] am: replace uses of --resolved with --continue
  2013-06-26 20:06 [PATCH] am: replace uses of --resolved with --continue Kevin Bracey
@ 2013-06-27  8:33 ` John Keeping
  2013-06-27 16:36   ` Junio C Hamano
  0 siblings, 1 reply; 3+ messages in thread
From: John Keeping @ 2013-06-27  8:33 UTC (permalink / raw)
  To: Kevin Bracey; +Cc: git, Jeff King

On Wed, Jun 26, 2013 at 11:06:41PM +0300, Kevin Bracey wrote:
> git am was previously modified to provide --continue for consistency
> with rebase, merge etc, and the documentation changed to showing
> --continue as the primary form.
> 
> Complete the work by replacing remaining uses of --resolved by
> --continue, most notably in suggested command reminders.
> 
> Signed-off-by: Kevin Bracey <kevin@bracey.fi>
> ---
>  Documentation/git-am.txt      | 4 ++--
>  Documentation/user-manual.txt | 2 +-
>  git-am.sh                     | 8 ++++----
>  t/t7512-status-help.sh        | 4 ++--
>  wt-status.c                   | 2 +-
>  5 files changed, 10 insertions(+), 10 deletions(-)
> 
> diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt
> index 5bbe7b6..54d8461 100644
> --- a/Documentation/git-am.txt
> +++ b/Documentation/git-am.txt
> @@ -132,7 +132,7 @@ default.   You can use `--no-utf8` to override this.
>  --resolvemsg=<msg>::
>  	When a patch failure occurs, <msg> will be printed
>  	to the screen before exiting.  This overrides the
> -	standard message informing you to use `--resolved`
> +	standard message informing you to use `--continue`
>  	or `--skip` to handle the failure.  This is solely
>  	for internal use between 'git rebase' and 'git am'.
>  
> @@ -176,7 +176,7 @@ aborts in the middle.  You can recover from this in one of two ways:
>  
>  . hand resolve the conflict in the working directory, and update
>    the index file to bring it into a state that the patch should
> -  have produced.  Then run the command with the '--resolved' option.
> +  have produced.  Then run the command with the '--continue' option.

It isn't new in this patch, but there is an inconsistency in the quoting
of the options here.  In the previous hunk we use backticks but here it
uses SQs.

The documentation isn't at all consistent on this, but
backticks seem to be the preferred style (there are some false positives
in both counts but this gives a good indication):

 $ git grep "'--" -- Documentation/ | wc -l
 186
 $ git grep '`--' -- Documentation/ | wc -l
 487

>  The command refuses to process new mailboxes until the current
>  operation is finished, so if you decide to start over from scratch,
> diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
> index e831cc2..8218cf9 100644
> --- a/Documentation/user-manual.txt
> +++ b/Documentation/user-manual.txt
> @@ -1835,7 +1835,7 @@ Once the index is updated with the results of the conflict
>  resolution, instead of creating a new commit, just run
>  
>  -------------------------------------------------
> -$ git am --resolved
> +$ git am --continue
>  -------------------------------------------------
>  
>  and Git will create the commit for you and continue applying the
> diff --git a/git-am.sh b/git-am.sh
> index 9f44509..7ea40fe 100755
> --- a/git-am.sh
> +++ b/git-am.sh
> @@ -6,7 +6,7 @@ SUBDIRECTORY_OK=Yes
>  OPTIONS_KEEPDASHDASH=
>  OPTIONS_SPEC="\
>  git am [options] [(<mbox>|<Maildir>)...]
> -git am [options] (--resolved | --skip | --abort)
> +git am [options] (--continue | --skip | --abort)
>  --
>  i,interactive   run interactively
>  b,binary*       (historical option -- no-op)
> @@ -102,7 +102,7 @@ stop_here_user_resolve () {
>  	    printf '%s\n' "$resolvemsg"
>  	    stop_here $1
>      fi
> -    eval_gettextln "When you have resolved this problem, run \"\$cmdline --resolved\".
> +    eval_gettextln "When you have resolved this problem, run \"\$cmdline --continue\".
>  If you prefer to skip this patch, run \"\$cmdline --skip\" instead.
>  To restore the original branch and stop patching, run \"\$cmdline --abort\"."
>  
> @@ -523,7 +523,7 @@ Use \"git am --abort\" to remove it.")"
>  		esac
>  	fi
>  
> -	# Make sure we are not given --skip, --resolved, nor --abort
> +	# Make sure we are not given --skip, --continue, nor --abort
>  	test "$skip$resolved$abort" = "" ||
>  		die "$(gettext "Resolve operation not in progress, we are not resuming.")"
>  
> @@ -670,7 +670,7 @@ do
>  	#  - patch is the patch body.
>  	#
>  	# When we are resuming, these files are either already prepared
> -	# by the user, or the user can tell us to do so by --resolved flag.
> +	# by the user, or the user can tell us to do so by --continue flag.
>  	case "$resume" in
>  	'')
>  		if test -f "$dotest/rebasing"
> diff --git a/t/t7512-status-help.sh b/t/t7512-status-help.sh
> index 4f09bec..bd8aab0 100755
> --- a/t/t7512-status-help.sh
> +++ b/t/t7512-status-help.sh
> @@ -510,7 +510,7 @@ test_expect_success 'status in an am session: file already exists' '
>  	cat >expected <<-\EOF &&
>  	# On branch am_already_exists
>  	# You are in the middle of an am session.
> -	#   (fix conflicts and then run "git am --resolved")
> +	#   (fix conflicts and then run "git am --continue")
>  	#   (use "git am --skip" to skip this patch)
>  	#   (use "git am --abort" to restore the original branch)
>  	#
> @@ -532,7 +532,7 @@ test_expect_success 'status in an am session: file does not exist' '
>  	cat >expected <<-\EOF &&
>  	# On branch am_not_exists
>  	# You are in the middle of an am session.
> -	#   (fix conflicts and then run "git am --resolved")
> +	#   (fix conflicts and then run "git am --continue")
>  	#   (use "git am --skip" to skip this patch)
>  	#   (use "git am --abort" to restore the original branch)
>  	#
> diff --git a/wt-status.c b/wt-status.c
> index 438a40d..b191c65 100644
> --- a/wt-status.c
> +++ b/wt-status.c
> @@ -826,7 +826,7 @@ static void show_am_in_progress(struct wt_status *s,
>  	if (advice_status_hints) {
>  		if (!state->am_empty_patch)
>  			status_printf_ln(s, color,
> -				_("  (fix conflicts and then run \"git am --resolved\")"));
> +				_("  (fix conflicts and then run \"git am --continue\")"));
>  		status_printf_ln(s, color,
>  			_("  (use \"git am --skip\" to skip this patch)"));
>  		status_printf_ln(s, color,
> -- 
> 1.8.3.rc0.28.g4b02ef5

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] am: replace uses of --resolved with --continue
  2013-06-27  8:33 ` John Keeping
@ 2013-06-27 16:36   ` Junio C Hamano
  0 siblings, 0 replies; 3+ messages in thread
From: Junio C Hamano @ 2013-06-27 16:36 UTC (permalink / raw)
  To: John Keeping; +Cc: Kevin Bracey, git, Jeff King

John Keeping <john@keeping.me.uk> writes:

>> @@ -176,7 +176,7 @@ aborts in the middle.  You can recover from this in one of two ways:
>>  
>>  . hand resolve the conflict in the working directory, and update
>>    the index file to bring it into a state that the patch should
>> -  have produced.  Then run the command with the '--resolved' option.
>> +  have produced.  Then run the command with the '--continue' option.
>
> It isn't new in this patch, but there is an inconsistency in the quoting
> of the options here.  In the previous hunk we use backticks but here it
> uses SQs.

Whatever the user is expected to literally type, like the dashed options,
should be typeset in tt so `--continue` is the right form.

I am not inviting anybody to throw a patch that was generated by
blindly running:

	sed -e "s/'\(--[a-z_]*\)'/`\1`/g"

to touch 50+ files without thinking, by the way.  It is so easy that
it can even be done by a trained monkey, but it also is very easy to
fail to spot misconversion.  Done in small batches with a throttled
rate of patchflow, we may have sufficient review bandwidth to audit
them.

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2013-06-27 16:36 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2013-06-26 20:06 [PATCH] am: replace uses of --resolved with --continue Kevin Bracey
2013-06-27  8:33 ` John Keeping
2013-06-27 16:36   ` Junio C Hamano

Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).