Skip to contentSkip to conversation

describe: Add unlisted option

PATCH In review Yasushi SHOJI 3 participants 5 messages Jun 15, 2016 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 describe: Add unlisted option

added unlisted options, --contains, --candidates and --debug, to usage line. also, prints some info when --contains and --debug are given.

---
 Documentation/git-describe.txt |    4 +++-
 builtin-describe.c             |    5 ++++-
 2 files changed, 7 insertions(+), 2 deletions(-)
Documentation/git-describe.txt +3 -1
index ac23e28..f0bcb61 100644
@@ -8,7 +8,9 @@ git-describe - Show the most recent tag that is reachable from a commit
 
 SYNOPSIS
 --------
-'git-describe' [--all] [--tags] [--contains] [--abbrev=<n>] <committish>...
+'git-describe' [--all] [--tags] [--contains] [--abbrev=<n>]
+               [--candidates=<n>] [--debug]
+               <committish>...
 
 DESCRIPTION
 -----------
builtin-describe.c +4 -1
index 669110c..e94f867 100644
@@ -9,7 +9,7 @@
 #define MAX_TAGS	(FLAG_BITS - 1)
 
 static const char describe_usage[] =
-"git-describe [--all] [--tags] [--abbrev=<n>] <committish>*";
+"git-describe [--all] [--tags] [--contains] [--abbrev=<n>] [--candidates] [--debug] <committish>*";
 
 static int debug;	/* Display lots of verbose info */
 static int all;	/* Default to annotated tags only */
@@ -283,6 +283,9 @@ int cmd_describe(int argc, const char **argv, const char *prefix)
 		args[2] = "--tags";
 		memcpy(args + 3, argv + i, (argc - i) * sizeof(char*));
 		args[3 + argc - i] = NULL;
+		if (debug)
+			fprintf(stderr, "redirecting to \"git name-rev\"; "
+				"no searching strategy will be printed\n");
 		return cmd_name_rev(3 + argc - i, args, prefix);
 	}
 
Signature · 1 line
1.5.3.rc2.4.g726f9
Acked-by on v1 1/1
#1 lore raw
Quoted 2 lines · Yasushi SHOJI

added unlisted options, --contains, --candidates and --debug, to usage line. also, prints some info when --contains and --debug are given.

That makes sense. Especially telling the user why --debug --contains doesn't actually print anything. ;-)

Originally I left out --candidates and --debug when I wrote the code for them as I thought they were a tad too internal for casual use. But maybe it makes sense to include them in the usage string.

Signature · 1 line
Shawn.
#2 lore raw
Quoted 10 lines · Shawn O. Pearce
Quoted 2 lines · Yasushi SHOJI

added unlisted options, --contains, --candidates and --debug, to usage line. also, prints some info when --contains and --debug are given.

That makes sense. Especially telling the user why --debug --contains doesn't actually print anything. ;-)

Originally I left out --candidates and --debug when I wrote the code for them as I thought they were a tad too internal for casual use. But maybe it makes sense to include them in the usage string.

I was actually going to suggest removing these options, that were primarily meant for debugging and tweaking while we figure out what the optimum default should be. Do you think they are worth keeping?

#3 lore raw
Quoted 9 lines · Junio C Hamano
Quoted 3 lines · Shawn O. Pearce

Originally I left out --candidates and --debug when I wrote the code for them as I thought they were a tad too internal for casual use. But maybe it makes sense to include them in the usage string.

I was actually going to suggest removing these options, that were primarily meant for debugging and tweaking while we figure out what the optimum default should be. Do you think they are worth keeping?

Yea, I do. I'd like to keep them in the code as sometimes I do look at their output. I'll even help maintain them, because they change oh so often. ;-)

But if you really want them gone, I won't stop you.

Signature · 1 line
Shawn.
#4 lore raw
Quoted 10 lines · Shawn O. Pearce
Quoted 4 lines

I was actually going to suggest removing these options, that were primarily meant for debugging and tweaking while we figure out what the optimum default should be. Do you think they are worth keeping?

Yea, I do. I'd like to keep them in the code as sometimes I do look at their output. I'll even help maintain them, because they change oh so often. ;-)

But if you really want them gone, I won't stop you.

Nah, I already noticed your Ack and inferred that you would want to keep them. Haven't applied the patches yet, though.