* [PATCH] reflog documentation: -n is an alias for --dry-run
@ 2009-09-13 3:41 Nelson Elhage
2009-09-13 9:40 ` Jeff King
0 siblings, 1 reply; 5+ messages in thread
From: Nelson Elhage @ 2009-09-13 3:41 UTC (permalink / raw)
To: git; +Cc: Nelson Elhage
Signed-off-by: Nelson Elhage <nelhage@mit.edu>
---
Documentation/git-reflog.txt | 2 +-
builtin-reflog.c | 4 ++--
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-reflog.txt b/Documentation/git-reflog.txt
index 7f7a544..b434ff7 100644
--- a/Documentation/git-reflog.txt
+++ b/Documentation/git-reflog.txt
@@ -16,7 +16,7 @@ The command takes various subcommands, and different options
depending on the subcommand:
[verse]
-'git reflog expire' [--dry-run] [--stale-fix] [--verbose]
+'git reflog expire' [-n | --dry-run] [--stale-fix] [--verbose]
[--expire=<time>] [--expire-unreachable=<time>] [--all] <refs>...
+
'git reflog delete' ref@\{specifier\}...
diff --git a/builtin-reflog.c b/builtin-reflog.c
index 95198c5..f37c57b 100644
--- a/builtin-reflog.c
+++ b/builtin-reflog.c
@@ -13,9 +13,9 @@
*/
static const char reflog_expire_usage[] =
-"git reflog (show|expire) [--verbose] [--dry-run] [--stale-fix] [--expire=<time>] [--expire-unreachable=<time>] [--all] <refs>...";
+"git reflog (show|expire) [--verbose] [-n | --dry-run] [--stale-fix] [--expire=<time>] [--expire-unreachable=<time>] [--all] <refs>...";
static const char reflog_delete_usage[] =
-"git reflog delete [--verbose] [--dry-run] [--rewrite] [--updateref] <refs>...";
+"git reflog delete [--verbose] [-n | --dry-run] [--rewrite] [--updateref] <refs>...";
static unsigned long default_reflog_expire;
static unsigned long default_reflog_expire_unreachable;
--
1.6.3.1.499.ge7b8da
^ permalink raw reply related [flat|nested] 5+ messages in thread* Re: [PATCH] reflog documentation: -n is an alias for --dry-run
2009-09-13 3:41 [PATCH] reflog documentation: -n is an alias for --dry-run Nelson Elhage
@ 2009-09-13 9:40 ` Jeff King
2009-09-13 12:53 ` Nelson Elhage
2009-09-13 13:05 ` Erik Faye-Lund
0 siblings, 2 replies; 5+ messages in thread
From: Jeff King @ 2009-09-13 9:40 UTC (permalink / raw)
To: Nelson Elhage; +Cc: git
On Sat, Sep 12, 2009 at 11:41:54PM -0400, Nelson Elhage wrote:
> static const char reflog_expire_usage[] =
> -"git reflog (show|expire) [--verbose] [--dry-run] [--stale-fix] [--expire=<time>] [--expire-unreachable=<time>] [--all] <refs>...";
> +"git reflog (show|expire) [--verbose] [-n | --dry-run] [--stale-fix] [--expire=<time>] [--expire-unreachable=<time>] [--all] <refs>...";
Really? I think "git reflog show -n" is not about dry-run at all...
-Peff
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] reflog documentation: -n is an alias for --dry-run
2009-09-13 9:40 ` Jeff King
@ 2009-09-13 12:53 ` Nelson Elhage
2009-09-13 13:26 ` Jeff King
2009-09-13 13:05 ` Erik Faye-Lund
1 sibling, 1 reply; 5+ messages in thread
From: Nelson Elhage @ 2009-09-13 12:53 UTC (permalink / raw)
To: Jeff King; +Cc: git
Oh, I see. I was reading builtin-reflog.c, which, in both
cmd_reflog_expire and cmd_reflog_delete, does check for -n as
synonymous to --dry-run:
if (!strcmp(arg, "--dry-run") || !strcmp(arg, "-n"))
cb.dry_run = 1;
but I missed that 'reflog show' aliases for git-log, and that that
accepts -n.
Patch withdrawn -- I'd send one documenting that -n works for delete
and expire, but it'd probably just complicate the documentation more
than clarify anything.
- Nelson
On Sun, Sep 13, 2009 at 05:40:32AM -0400, Jeff King wrote:
> On Sat, Sep 12, 2009 at 11:41:54PM -0400, Nelson Elhage wrote:
>
> > static const char reflog_expire_usage[] =
> > -"git reflog (show|expire) [--verbose] [--dry-run] [--stale-fix] [--expire=<time>] [--expire-unreachable=<time>] [--all] <refs>...";
> > +"git reflog (show|expire) [--verbose] [-n | --dry-run] [--stale-fix] [--expire=<time>] [--expire-unreachable=<time>] [--all] <refs>...";
>
> Really? I think "git reflog show -n" is not about dry-run at all...
>
> -Peff
^ permalink raw reply [flat|nested] 5+ messages in thread* Re: [PATCH] reflog documentation: -n is an alias for --dry-run
2009-09-13 12:53 ` Nelson Elhage
@ 2009-09-13 13:26 ` Jeff King
0 siblings, 0 replies; 5+ messages in thread
From: Jeff King @ 2009-09-13 13:26 UTC (permalink / raw)
To: Nelson Elhage; +Cc: git
On Sun, Sep 13, 2009 at 08:53:13AM -0400, Nelson Elhage wrote:
> Patch withdrawn -- I'd send one documenting that -n works for delete
> and expire, but it'd probably just complicate the documentation more
> than clarify anything.
I think it would be fine to just split the (show|expire) line into two
separate lines:
> > > -"git reflog (show|expire) [--verbose] [--dry-run] [--stale-fix] [--expire=<time>] [--expire-unreachable=<time>] [--all] <refs>...";
> > > +"git reflog (show|expire) [--verbose] [-n | --dry-run] [--stale-fix] [--expire=<time>] [--expire-unreachable=<time>] [--all] <refs>...";
-Peff
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] reflog documentation: -n is an alias for --dry-run
2009-09-13 9:40 ` Jeff King
2009-09-13 12:53 ` Nelson Elhage
@ 2009-09-13 13:05 ` Erik Faye-Lund
1 sibling, 0 replies; 5+ messages in thread
From: Erik Faye-Lund @ 2009-09-13 13:05 UTC (permalink / raw)
To: Jeff King; +Cc: Nelson Elhage, git
On Sun, Sep 13, 2009 at 11:40 AM, Jeff King <peff@peff.net> wrote:
>> static const char reflog_expire_usage[] =
>> -"git reflog (show|expire) [--verbose] [--dry-run] [--stale-fix] [--expire=<time>] [--expire-unreachable=<time>] [--all] <refs>...";
>> +"git reflog (show|expire) [--verbose] [-n | --dry-run] [--stale-fix] [--expire=<time>] [--expire-unreachable=<time>] [--all] <refs>...";
>
> Really? I think "git reflog show -n" is not about dry-run at all...
Indeed. However, the reflog expire uses -n as an alias for --dry-run,
according to lines 548-549 of my builtin-reflog.c (ddfdf5a):
if (!strcmp(arg, "--dry-run") || !strcmp(arg, "-n"))
cb.dry_run = 1;
...and this usage-string is only output from cmd_reflog_expire, so the
correct solution would IMO be to simply remove show from the
usage-string:
-"git reflog (show|expire) [--verbose] [-n | --dry-run] [--stale-fix]
[--expire=<time>] [--expire-unreachable=<time>] [--all] <refs>...";
+"git reflog expire [--verbose] [-n | --dry-run] [--stale-fix]
[--expire=<time>] [--expire-unreachable=<time>] [--all] <refs>...";
This issue ("reflog expire" incorrectly documenting "reflog show") was
present before this patch, though. At least the option "--stale-fix"
appears not to be valid for "reflog show".
--
Erik "kusma" Faye-Lund
kusmabite@gmail.com
(+47) 986 59 656
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2009-09-13 13:26 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2009-09-13 3:41 [PATCH] reflog documentation: -n is an alias for --dry-run Nelson Elhage
2009-09-13 9:40 ` Jeff King
2009-09-13 12:53 ` Nelson Elhage
2009-09-13 13:26 ` Jeff King
2009-09-13 13:05 ` Erik Faye-Lund
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 NNTP newsgroup(s).