git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v2 10/11] bisect: check get_terms return at all call sites

From
Junio C Hamano <gitster@pobox.com>
Date
Aug 5, 2026, 20:26 UTC
Message-ID
<xmqqecgcpb4p.fsf@gitster.g>
In-Reply-To
<9a9103096a2bd877f84502cffefd019d0a6e229d.1785954661.git.gitgitgadget@gmail.com>

"Johannes Schindelin via GitGitGadget" <gitgitgadget@gmail.com> writes:

Show 5 quoted lines
> There is one slight complication here: One caller _needs_ the return
> value to indicate an error when the `BISECT_TERMS` file is absent, all
> the other call sites are totally okay with a "missing" `BISECT_TERMS`
> file. To address that, extend the function signature of `get_terms()` to
> indicate which behavior the caller wants.
Show 13 quoted lines
> -static int get_terms(struct bisect_terms *terms)
> +static int get_terms(struct bisect_terms *terms, int file_missing_is_ok)
>  {
>  	struct strbuf str = STRBUF_INIT;
>  	FILE *fp = NULL;
> @@ -493,7 +493,7 @@ static int get_terms(struct bisect_terms *terms)
>  
>  	fp = fopen(git_path_bisect_terms(), "r");
>  	if (!fp) {
> -		res = -1;
> +		res = file_missing_is_ok ? 0 : -1;
>  		goto finish;
>  	}

Hmph. So, depending on the caller, a missing file error may have to be treated as OK or as an error, while all other kinds of anomalies are treated by all callers as errors.

As all the existing callsites of this function need to be adjusted for this change anyway, I would have thought a more typical way to handle a situation like this would be to define different error codes for this function and have the callers deal with them. But it seems that almost all callers, except for one, pass "missing is OK."

So, instead of adjusting the majority of callers with something like:
        -       if (get_terms(...))
        +       if (get_terms(...) == BISECT_TERMS_ERROR)
                        oops we got an error

and keeping only the single oddball caller to barf on any non-zero return,

        -       if (get_terms(...))
        +       switch (get_terms(...)) {
	+	case BISECT_TERMS_ERROR:
                        oops we got an error
	+		break;
	+	case BISECT_TERMS_MISSING_FILE:
	+		deal with the missing file error
	+		break;
	+	default:
	+		break; /* ok */
	+	}
it may be simpler to change:
        -       if (get_terms(...))
        +       if (get_terms(..., 1))
                        oops we got an error
for the majority of them.  The one oddball caller then becomes:
        -       if (get_terms(...))
        +       if (get_terms(..., 0))
                        oops we got an error
to treat a missing file as an error as well.
I guess I can buy that.

If get_terms() were a public function that had many more callers, my preference would probably be very different. But this is local to a single file, so the meaning of the mysterious 0/1 parameter will quickly become evident to those who have to work with this part of the system anyway.

Thanks.
Previous: Johannes Schindelin via GitGitGadgetNext: Johannes Schindelin via GitGitGadget
Message 39 of 60 in “coverity: fix unchecked returns”
  1. 00/11 coverity: fix unchecked returnsJohannes Schindelin via GitGitGadget, Jul 14, 2026
  2. 01/11 http: die on curl_easy_duphandle failure in get_active_slotJohannes Schindelin via GitGitGadget, Jul 14, 2026
  3. 02/11 config: propagate launch_editor() failure in show_editor()Johannes Schindelin via GitGitGadget, Jul 14, 2026
  4. Patrick SteinhardtJul 15, 2026
  5. 03/11 reftable/block: check deflateInit() return valueJohannes Schindelin via GitGitGadget, Jul 14, 2026
  6. 04/11 reftable tests: check reftable_table_init_ref_iterator() returnJohannes Schindelin via GitGitGadget, Jul 14, 2026
  7. 05/11 last-modified: handle repo_parse_commit() failuresJohannes Schindelin via GitGitGadget, Jul 14, 2026
  8. Junio C HamanoJul 15, 2026
  9. Junio C HamanoJul 20, 2026
  10. Johannes SchindelinAug 5, 2026
  11. 06/11 compat/pread: check initial lseek for errorsJohannes Schindelin via GitGitGadget, Jul 14, 2026
  12. Patrick SteinhardtJul 15, 2026
  13. Johannes SchindelinAug 5, 2026
  14. 07/11 transport-helper: check dup() return in get_exporterJohannes Schindelin via GitGitGadget, Jul 14, 2026
  15. Patrick SteinhardtJul 15, 2026
  16. 08/11 transport-helper: warn when export-marks file cannot be finalizedJohannes Schindelin via GitGitGadget, Jul 14, 2026
  17. 09/11 bisect: check strbuf_getline_lf return when reading termsJohannes Schindelin via GitGitGadget, Jul 14, 2026
  18. Junio C HamanoJul 15, 2026
  19. Junio C HamanoJul 20, 2026
  20. Johannes SchindelinAug 5, 2026
  21. 10/11 bisect: check get_terms return at all call sitesJohannes Schindelin via GitGitGadget, Jul 14, 2026
  22. Patrick SteinhardtJul 15, 2026
  23. Johannes SchindelinAug 5, 2026
  24. 11/11 bisect: handle dup() failure when redirecting stdoutJohannes Schindelin via GitGitGadget, Jul 14, 2026
  25. Patrick SteinhardtJul 15, 2026
  26. Johannes SchindelinAug 5, 2026
  27. 00/11 coverity: fix unchecked returnsJohannes Schindelin via GitGitGadget, Aug 5, 2026
  28. 01/11 http: die on curl_easy_duphandle failure in get_active_slotJohannes Schindelin via GitGitGadget, Aug 5, 2026
  29. 02/11 config: propagate launch_editor() failure in show_editor()Johannes Schindelin via GitGitGadget, Aug 5, 2026
  30. 03/11 reftable/block: check deflateInit() return valueJohannes Schindelin via GitGitGadget, Aug 5, 2026
  31. Junio C HamanoAug 6, 2026
  32. 04/11 reftable tests: check reftable_table_init_ref_iterator() returnJohannes Schindelin via GitGitGadget, Aug 5, 2026
  33. 05/11 last-modified: handle repo_parse_commit() failuresJohannes Schindelin via GitGitGadget, Aug 5, 2026
  34. 06/11 compat/pread: check initial lseek for errorsJohannes Schindelin via GitGitGadget, Aug 5, 2026
  35. 07/11 transport-helper: check dup() return in get_exporterJohannes Schindelin via GitGitGadget, Aug 5, 2026
  36. 08/11 transport-helper: warn when export-marks file cannot be finalizedJohannes Schindelin via GitGitGadget, Aug 5, 2026
  37. 09/11 bisect: check strbuf_getline_lf return when reading termsJohannes Schindelin via GitGitGadget, Aug 5, 2026
  38. 10/11 bisect: check get_terms return at all call sitesJohannes Schindelin via GitGitGadget, Aug 5, 2026
  39. Junio C HamanoAug 5, 2026
  40. 11/11 bisect: handle dup() failure when redirecting stdoutJohannes Schindelin via GitGitGadget, Aug 5, 2026
  41. Jeff KingAug 6, 2026
  42. Junio C HamanoAug 6, 2026
  43. 00/12 coverity: fix unchecked returnsJohannes Schindelin via GitGitGadget, Aug 12, 2026
  44. 01/12 http: die on curl_easy_duphandle failure in get_active_slotJohannes Schindelin via GitGitGadget, Aug 12, 2026
  45. 02/12 config: propagate launch_editor() failure in show_editor()Johannes Schindelin via GitGitGadget, Aug 12, 2026
  46. 03/12 reftable: handle block-writer initialization errorsJohannes Schindelin via GitGitGadget, Aug 12, 2026
  47. 04/12 reftable/block: check deflateInit() return valueJohannes Schindelin via GitGitGadget, Aug 12, 2026
  48. 05/12 reftable tests: check reftable_table_init_ref_iterator() returnJohannes Schindelin via GitGitGadget, Aug 12, 2026
  49. 06/12 last-modified: handle repo_parse_commit() failuresJohannes Schindelin via GitGitGadget, Aug 12, 2026
  50. 07/12 compat/pread: check initial lseek for errorsJohannes Schindelin via GitGitGadget, Aug 12, 2026
  51. 08/12 transport-helper: check dup() return in get_exporterJohannes Schindelin via GitGitGadget, Aug 12, 2026
  52. 09/12 transport-helper: warn when export-marks file cannot be finalizedJohannes Schindelin via GitGitGadget, Aug 12, 2026
  53. Patrick SteinhardtAug 13, 2026
  54. 10/12 bisect: check strbuf_getline_lf return when reading termsJohannes Schindelin via GitGitGadget, Aug 12, 2026
  55. 11/12 bisect: check get_terms return at all call sitesJohannes Schindelin via GitGitGadget, Aug 12, 2026
  56. 12/12 bisect: handle dup() failure when redirecting stdoutJohannes Schindelin via GitGitGadget, Aug 12, 2026
  57. Jeff KingAug 12, 2026
  58. Junio C HamanoAug 12, 2026
  59. Jeff KingAug 12, 2026
  60. Patrick SteinhardtAug 13, 2026

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.