[PATCH] usage_with_options: omit double new line on empty option list

From: Stefan Beller <sbeller@google.com>
Date: Aug 25, 2017, 19:28 UTC
Message-ID: <20170825192813.15697-1-sbeller@google.com>
In-Reply-To: <xmqqy3q7sge2.fsf@gitster.mtv.corp.google.com/>

Currently the worktree command gives its usage, when no subcommand is given. However there are no general options, all options are related to the subcommands itself, such that:

 #    $ git worktree
 #    usage: git worktree add [<options>] <path> [<branch>]
 #       or: git worktree list [<options>]
 #       or: git worktree lock [<options>] <path>
 #       or: git worktree prune [<options>]
 #       or: git worktree unlock <path>
 #
 #
 #    $

Note the two empty lines at the end of the usage string. This is because the toplevel usage is printed with an empty options list.

Only print a new line after the option list if it is not empty.

Signed-off-by: Stefan Beller <sbeller@google.com>
---

Show 13 quoted lines

> I have this feeling that this patch may not be sufficient.
>
> The reason for the first blank line is because we unconditionally
> emit one, expecting that we would have a list of options to show and
> want to separate the usage from that list, and the fix in this patch
> is correct---it is the right way to suppress it.
>
> But why do we need the second blank line in this case?  There is a
> similar unconditional LF near the end of this function.  Is somebody
> else (other than usage_with_options() which will exit immeidately)
> calls this function and expects to say something more after what
> this function said, and is this extra blank line at the end is to
> prepare for that caller?

Good point, parse_options[_step] also makes use of the usage_with_options_internal, such that the regular options need to work, with a potentially interesting arrangement of OPTION_GROUPs.

I think this one is cleaner, as it omits the correct LF.

Thanks, Stefan

 parse-options.c | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/parse-options.c b/parse-options.c
index 0dd9fc6a0d..2829c16b01 100644
--- a/parse-options.c
+++ b/parse-options.c
@@ -580,6 +580,7 @@ static int usage_with_options_internal(struct parse_opt_ctx_t *ctx,
 				       const char * const *usagestr,
 				       const struct option *opts, int full, int err)
 {
+	int new_line_after_opts;
 	FILE *outfile = err ? stderr : stdout;
 
 	if (!usagestr)
@@ -606,6 +607,8 @@ static int usage_with_options_internal(struct parse_opt_ctx_t *ctx,
 	if (opts->type != OPTION_GROUP)
 		fputc('\n', outfile);
 
+	new_line_after_opts = (opts->type != OPTION_END);
+
 	for (; opts->type != OPTION_END; opts++) {
 		size_t pos;
 		int pad;
@@ -645,7 +648,9 @@ static int usage_with_options_internal(struct parse_opt_ctx_t *ctx,
 		}
 		fprintf(outfile, "%*s%s\n", pad + USAGE_GAP, "", _(opts->help));
 	}
-	fputc('\n', outfile);
+
+	if (new_line_after_opts)
+		fputc('\n', outfile);
 
 	if (!err && ctx && ctx->flags & PARSE_OPT_SHELL_EVAL)
 		fputs("EOF\n", outfile);

-- 
2.14.0.rc0.3.g6c2e499285