git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Miriam Rubio <mirucam@gmail.com>
Cc: git@vger.kernel.org, Christian Couder <chriscool@tuxfamily.org>,
	Johannes Schindelin <Johannes.Schindelin@gmx.de>
Subject: Re: [PATCH v4 03/13] bisect--helper: introduce new `write_in_file()` function
Date: Wed, 08 Jul 2020 12:52:03 -0700	[thread overview]
Message-ID: <xmqqwo3d23a4.fsf@gitster.c.googlers.com> (raw)
In-Reply-To: <20200701133504.18360-4-mirucam@gmail.com> (Miriam Rubio's message of "Wed, 1 Jul 2020 15:34:54 +0200")

Miriam Rubio <mirucam@gmail.com> writes:

> +static int write_in_file(const char *path, const char *mode, const char *format, va_list args)
> +{
> +	FILE *fp = NULL;
> +	int res = 0;
> +
> +	if (!strcmp(mode, "a") && !strcmp(mode, "w"))
> +		return error(_("wrong writing mode '%s'"), mode);

How can a string "mode" be equal to "a" and "w" at the same time?

The only caller you have at this point passes "w" and nothing else.
It may be easier to follow the evolution of the code in the series 
if you left this as

	if (strcmp(mode, "w"))
		BUG("write-in-file does not support '%s' mode", mode);

at this step, and turned it into

	if (strcmp(mode, "w") && strcmp(mode, "a"))
		BUG("write-in-file does not support '%s' mode", mode);

in the step where a caller starts to call it for appending.

> +	fp = fopen(path, mode);
> +	if (!fp)
> +		return error_errno(_("cannot open file '%s' in mode '%s'"), path, mode);
> +	res = vfprintf(fp, format, args);
> +
> +	if (!res) {

Shouldn't this check for negative return?  It is not an error to
pass format that ends up writing nothing, but any error should be
reported by returning a negative value from vfprintf(), I would
think.

    (a tip for a student/mentee)

    Any time you call a system library you are not familiar with,
    make it a habit to always consult its manual page for return
    values and its error reporting convention.

>  	if (!strcmp(bad, good))
> @@ -113,12 +144,8 @@ static int write_terms(const char *bad, const char *good)
>  	if (check_term_format(bad, "bad") || check_term_format(good, "good"))
>  		return -1;
>  
> -	fp = fopen(git_path_bisect_terms(), "w");
> -	if (!fp)
> -		return error_errno(_("could not open the file BISECT_TERMS"));
> +	res = write_to_file(git_path_bisect_terms(), "%s\n%s\n", bad, good);
>  
> -	res = fprintf(fp, "%s\n%s\n", bad, good);
> -	res |= fclose(fp);
>  	return (res < 0) ? -1 : 0;

Shouldn't this now be just

	return res;

as all the error codepaths that can reach here are returning error()
or error_errno() after this patch?

>  }

  parent reply	other threads:[~2020-07-08 19:52 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-01 13:34 [PATCH v4 00/13] Finish converting git bisect to C part 2 Miriam Rubio
2020-07-01 13:34 ` [PATCH v4 01/13] bisect--helper: BUG() in cmd_*() on invalid subcommand Miriam Rubio
2020-07-01 13:34 ` [PATCH v4 02/13] bisect--helper: use '-res' in 'cmd_bisect__helper' return Miriam Rubio
2020-07-01 13:34 ` [PATCH v4 03/13] bisect--helper: introduce new `write_in_file()` function Miriam Rubio
2020-07-01 14:56   ` Chris Torek
2020-07-08 19:52   ` Junio C Hamano [this message]
2020-07-01 13:34 ` [PATCH v4 04/13] bisect--helper: reimplement `bisect_autostart` shell function in C Miriam Rubio
2020-07-01 13:34 ` [PATCH v4 05/13] bisect: call 'clear_commit_marks_all()' in 'bisect_next_all()' Miriam Rubio
2020-07-01 13:34 ` [PATCH v4 06/13] bisect--helper: reimplement `bisect_next` and `bisect_auto_next` shell functions in C Miriam Rubio
2020-07-01 13:34 ` [PATCH v4 07/13] bisect--helper: finish porting `bisect_start()` to C Miriam Rubio
2020-07-01 13:34 ` [PATCH v4 08/13] bisect--helper: retire `--bisect-clean-state` subcommand Miriam Rubio
2020-07-01 13:35 ` [PATCH v4 09/13] bisect--helper: retire `--next-all` subcommand Miriam Rubio
2020-07-01 13:35 ` [PATCH v4 10/13] bisect--helper: reimplement `bisect_state` & `bisect_head` shell functions in C Miriam Rubio
2020-07-08 21:38   ` Junio C Hamano
2020-07-01 13:35 ` [PATCH v4 11/13] bisect--helper: retire `--check-expected-revs` subcommand Miriam Rubio
2020-07-01 13:35 ` [PATCH v4 12/13] bisect--helper: retire `--write-terms` subcommand Miriam Rubio
2020-07-01 13:35 ` [PATCH v4 13/13] bisect--helper: retire `--bisect-autostart` subcommand Miriam Rubio

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqwo3d23a4.fsf@gitster.c.googlers.com \
    --to=gitster@pobox.com \
    --cc=Johannes.Schindelin@gmx.de \
    --cc=chriscool@tuxfamily.org \
    --cc=git@vger.kernel.org \
    --cc=mirucam@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

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 read-only IMAP folder(s) and NNTP newsgroup(s).