* [PATCH] reflog: Usage documentation cleanup
@ 2009-09-13 17:23 Nelson Elhage
0 siblings, 0 replies; only message in thread
From: Nelson Elhage @ 2009-09-13 17:23 UTC (permalink / raw)
To: git; +Cc: Nelson Elhage
* Make git-reflog.txt and the builtin usage text consistent.
* Make 'git reflog expire' not claim that 'show' takes the same
arguments as 'expire'.
* Document -n as an alias for --dry-run for the expire and delete
subcommands.
---
Documentation/git-reflog.txt | 5 +++--
builtin-reflog.c | 4 ++--
2 files changed, 5 insertions(+), 4 deletions(-)
Thanks to Jeff King and Erik Faye-Lund for both pointing out that 'git
reflog expire' is probably wrong to be documenting the 'show' command
in the first place, which makes this cleanup much saner.
diff --git a/Documentation/git-reflog.txt b/Documentation/git-reflog.txt
index 7f7a544..2c90c2c 100644
--- a/Documentation/git-reflog.txt
+++ b/Documentation/git-reflog.txt
@@ -16,10 +16,11 @@ 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\}...
+'git reflog delete [--verbose] [-n | --dry-run] [--rewrite]
+ [--updateref] ref@\{specifier}\...'
+
'git reflog' ['show'] [log-options] [<ref>]
diff --git a/builtin-reflog.c b/builtin-reflog.c
index 95198c5..4da5c6b 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 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] ref@{specifier}...";
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] only message in thread
only message in thread, other threads:[~2009-09-13 17:28 UTC | newest]
Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2009-09-13 17:23 [PATCH] reflog: Usage documentation cleanup Nelson Elhage
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).