diff mbox series

[1/3] format-patch: refactor output selection

Message ID 20201104132522.GA3030146@coredump.intra.peff.net (mailing list archive)
State Superseded
Headers show
Series [1/3] format-patch: refactor output selection | expand

Commit Message

Jeff King Nov. 4, 2020, 1:25 p.m. UTC
The --stdout and --output-directory options are mutually exclusive, but
it's hard to tell from reading the code. We have three separate
conditionals that check for use_stdout, and it's only after we've set up
the output_directory fully that we check whether the user also specified
--stdout.

Instead, let's check the exclusion explicitly first, then have a single
conditional that handles stdout versus an output directory. This is
slightly easier to follow now, and also will keep things sane when we
add another output mode in a future patch.

Signed-off-by: Jeff King <peff@peff.net>
---
 builtin/log.c | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

Comments

Eric Sunshine Nov. 4, 2020, 5:01 p.m. UTC | #1
On Wed, Nov 4, 2020 at 8:25 AM Jeff King <peff@peff.net> wrote:
> The --stdout and --output-directory options are mutually exclusive, but
> it's hard to tell from reading the code. We have three separate
> conditionals that check for use_stdout, and it's only after we've set up
> the output_directory fully that we check whether the user also specified
> --stdout.
>
> Instead, let's check the exclusion explicitly first, then have a single
> conditional that handles stdout versus an output directory. This is
> slightly easier to follow now, and also will keep things sane when we
> add another output mode in a future patch.
>
> Signed-off-by: Jeff King <peff@peff.net>
> ---
> diff --git a/builtin/log.c b/builtin/log.c
> @@ -1942,20 +1942,20 @@ int cmd_format_patch(int argc, const char **argv, const char *prefix)
> +       if (use_stdout + !!output_directory > 1)
> +               die(_("specify only one of --stdout, --output, and --output-directory"));

Is mention of --output intentional here? The commit message only talks
about --stdout and --output-directory.

It's subjective, but "mutually exclusive" sounds a bit more consistent
with other similar error messages elsewhere:

    --stdout, --output, and --output-directory are mutually exclusive
Jeff King Nov. 4, 2020, 5:13 p.m. UTC | #2
On Wed, Nov 04, 2020 at 12:01:53PM -0500, Eric Sunshine wrote:

> > diff --git a/builtin/log.c b/builtin/log.c
> > @@ -1942,20 +1942,20 @@ int cmd_format_patch(int argc, const char **argv, const char *prefix)
> > +       if (use_stdout + !!output_directory > 1)
> > +               die(_("specify only one of --stdout, --output, and --output-directory"));
> 
> Is mention of --output intentional here? The commit message only talks
> about --stdout and --output-directory.

Whoops, thanks. I wrote this line after adding the new feature, but
forgot to revise it when I rebased.

> It's subjective, but "mutually exclusive" sounds a bit more consistent
> with other similar error messages elsewhere:
> 
>     --stdout, --output, and --output-directory are mutually exclusive

Yeah, that reads better. I remember I reworded it a few times to try to
get it not-awkward, but I'm not sure how I failed to come up with that
quite obvious wording. ;)

-Peff
diff mbox series

Patch

diff --git a/builtin/log.c b/builtin/log.c
index 9f939e6cdf..4c391ba3ca 100644
--- a/builtin/log.c
+++ b/builtin/log.c
@@ -1942,20 +1942,20 @@  int cmd_format_patch(int argc, const char **argv, const char *prefix)
 	if (rev.show_notes)
 		load_display_notes(&rev.notes_opt);
 
-	if (!output_directory && !use_stdout)
-		output_directory = config_output_directory;
+	if (use_stdout + !!output_directory > 1)
+		die(_("specify only one of --stdout, --output, and --output-directory"));
 
-	if (!use_stdout)
-		output_directory = set_outdir(prefix, output_directory);
-	else
+	if (use_stdout) {
 		setup_pager();
-
-	if (output_directory) {
+	} else {
 		int saved;
+
+		if (!output_directory)
+			output_directory = config_output_directory;
+		output_directory = set_outdir(prefix, output_directory);
+
 		if (rev.diffopt.use_color != GIT_COLOR_ALWAYS)
 			rev.diffopt.use_color = GIT_COLOR_NEVER;
-		if (use_stdout)
-			die(_("standard output, or directory, which one?"));
 		/*
 		 * We consider <outdir> as 'outside of gitdir', therefore avoid
 		 * applying adjust_shared_perm in s-c-l-d.