threads / patch / 27051

patchrevert: Hide '-r' option in default usage

Subject: [PATCH] revert: Hide '-r' option in default usage

## tl;dr

4 messages between Apr 10, 2011 and Apr 13, 2011. Diffs are folded; open one to read it.

replies: 3people: 2as markdown or json

Ramkumar Ramachandra· Apr 10, 2011, 15:39 UTC · lore

Since the '-r' command-line option is a no-op provided only for backward compatiblity, don't advertise it in the default usage.

Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>
---
This is a minor detail I noticed while working on the sequencer.

 builtin/revert.c |    3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)

Show changes to builtin/revert.c +2 −1

diff --git a/builtin/revert.c b/builtin/revert.c
index 2bb13eb..f697e66 100644
--- a/builtin/revert.c
+++ b/builtin/revert.c
@@ -76,7 +76,8 @@ static void parse_args(int argc, const char **argv)
 	struct option options[] = {
 		OPT_BOOLEAN('n', "no-commit", &no_commit, "don't automatically commit"),
 		OPT_BOOLEAN('e', "edit", &edit, "edit the commit message"),
-		OPT_BOOLEAN('r', NULL, &noop, "no-op (backward compatibility)"),
+		{ OPTION_BOOLEAN, 'r', NULL, &noop, NULL, "no-op (backward compatibility)",
+		  PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 0 },
 		OPT_BOOLEAN('s', "signoff", &signoff, "add Signed-off-by:"),
 		OPT_INTEGER('m', "mainline", &mainline, "parent number"),
 		OPT_RERERE_AUTOUPDATE(&allow_rerere_auto),

-- 
1.7.4.rc1.7.g2cf08.dirty

Junio C Hamano· Apr 11, 2011, 21:06 UTC · re: Ramkumar Ramachandra · lore

Re: [PATCH] revert: Hide '-r' option in default usage

Ramkumar Ramachandra <artagnon@gmail.com> writes:

Show 5 quoted lines

> Since the '-r' command-line option is a no-op provided only for
> backward compatiblity, don't advertise it in the default usage.
>
> Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>
> ---

Thanks.

It would have saved me a lot of time if you wrote that this option has been a no-op since abd6970 (cherry-pick: make -r the default, 2006-10-05), but the commit didn't remove it from the usage string, and it somehow survived 9509af6 (Make git-revert & git-cherry-pick a builtin, 2007-03-01) and later f810379 (Make builtin-revert.c use parse_options, 2007-10-07), and it is about time to stop advertising it.

Show 19 quoted lines

> This is a minor detail I noticed while working on the sequencer.
>
>  builtin/revert.c |    3 ++-
>  1 files changed, 2 insertions(+), 1 deletions(-)
>
> diff --git a/builtin/revert.c b/builtin/revert.c
> index 2bb13eb..f697e66 100644
> --- a/builtin/revert.c
> +++ b/builtin/revert.c
> @@ -76,7 +76,8 @@ static void parse_args(int argc, const char **argv)
>  	struct option options[] = {
>  		OPT_BOOLEAN('n', "no-commit", &no_commit, "don't automatically commit"),
>  		OPT_BOOLEAN('e', "edit", &edit, "edit the commit message"),
> -		OPT_BOOLEAN('r', NULL, &noop, "no-op (backward compatibility)"),
> +		{ OPTION_BOOLEAN, 'r', NULL, &noop, NULL, "no-op (backward compatibility)",
> +		  PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 0 },
>  		OPT_BOOLEAN('s', "signoff", &signoff, "add Signed-off-by:"),
>  		OPT_INTEGER('m', "mainline", &mainline, "parent number"),
>  		OPT_RERERE_AUTOUPDATE(&allow_rerere_auto),

Ramkumar Ramachandra· Apr 13, 2011, 13:21 UTC · re: Junio C Hamano · lore

Re: [PATCH] revert: Hide '-r' option in default usage

Hi Junio,

Junio C Hamano writes:

Show 16 quoted lines

> Ramkumar Ramachandra <artagnon@gmail.com> writes:
> 
> > Since the '-r' command-line option is a no-op provided only for
> > backward compatiblity, don't advertise it in the default usage.
> >
> > Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>
> > ---
> 
> Thanks.
> 
> It would have saved me a lot of time if you wrote that this option has
> been a no-op since abd6970 (cherry-pick: make -r the default, 2006-10-05),
> but the commit didn't remove it from the usage string, and it somehow
> survived 9509af6 (Make git-revert & git-cherry-pick a builtin, 2007-03-01)
> and later f810379 (Make builtin-revert.c use parse_options, 2007-10-07),
> and it is about time to stop advertising it.

Thanks. I didn't realize there was so much history to write about. Has you queued this somewhere?

-- Ram

Junio C Hamano· Apr 13, 2011, 18:09 UTC · re: Ramkumar Ramachandra · lore

Re: [PATCH] revert: Hide '-r' option in default usage

Ramkumar Ramachandra <artagnon@gmail.com> writes:

Show 21 quoted lines

> Hi Junio,
>
> Junio C Hamano writes:
>> Ramkumar Ramachandra <artagnon@gmail.com> writes:
>> 
>> > Since the '-r' command-line option is a no-op provided only for
>> > backward compatiblity, don't advertise it in the default usage.
>> >
>> > Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>
>> > ---
>> 
>> Thanks.
>> 
>> It would have saved me a lot of time if you wrote that this option has
>> been a no-op since abd6970 (cherry-pick: make -r the default, 2006-10-05),
>> but the commit didn't remove it from the usage string, and it somehow
>> survived 9509af6 (Make git-revert & git-cherry-pick a builtin, 2007-03-01)
>> and later f810379 (Make builtin-revert.c use parse_options, 2007-10-07),
>> and it is about time to stop advertising it.
>
> Thanks.  I didn't realize there was so much history to write about.

Not necessarily in the final commit message; before "---" would have been sufficient.

> Has you queued this somewhere?

Sorry, after spending time to dig the history to see when we made this a no-op to ensure that it was sufficiently long time ago and wrote my finding in the message to you, I forgot to apply the patch. Will queue.

Thanks.