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

[PATCH 11/14] inherit_tracking(): defensive programming

From
Johannes Schindelin via GitGitGadget <gitgitgadget@gmail.com>
Date
May 15, 2025, 12:45 UTC
Message-ID
<dec21f89ffd06d8b307e7f46191be3824bd99b96.1747313140.git.gitgitgadget@gmail.com>
In-Reply-To
<pull.1890.git.1747313139.gitgitgadget@gmail.com>
From: Johannes Schindelin <johannes.schindelin@gmx.de>
CodeQL points out that `branch_get()` can return NULL values.

Note that the error path in this instance calls `BUG()`, not `die()`, for two reasons:

1. The code lives in `libgit.a` and calling `die()` from within those
   library functions is a bad practice that needs to be reduced, rather
   than increased.
2. The `inherit_tracking()` function really should only be called with
   the name of an existing branch, therefore a `NULL` return value would
   indeed constitute a bug in Git's code.
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
---
 branch.c | 2 ++
 1 file changed, 2 insertions(+)
diff --git a/branch.c b/branch.c
index 91297d55ac9f..a10b6119b214 100644
--- a/branch.c
+++ b/branch.c
@@ -224,6 +224,8 @@ static int inherit_tracking(struct tracking *tracking, const char *orig_ref)
 	skip_prefix(orig_ref, "refs/heads/", &bare_ref);
 
 	branch = branch_get(bare_ref);
+	if (!branch)
+		BUG("could not get branch for '%s", bare_ref);
 	if (!branch->remote_name) {
 		warning(_("asked to inherit tracking from '%s', but no remote is set"),
 			bare_ref);
-- 
gitgitgadget
Previous: Johannes Schindelin via GitGitGadgetNext: Johannes Schindelin via GitGitGadget
Message 16 of 19 in “Some defensive programming”
  1. 00/14 Some defensive programmingJohannes Schindelin via GitGitGadget, May 15, 2025
  2. 01/14 revision: defensive programmingJohannes Schindelin via GitGitGadget, May 15, 2025
  3. Junio C HamanoMay 15, 2025
  4. 02/14 get_parent(): defensive programmingJohannes Schindelin via GitGitGadget, May 15, 2025
  5. Junio C HamanoMay 15, 2025
  6. Jeff KingMay 15, 2025
  7. 03/14 fetch-pack: defensive programmingJohannes Schindelin via GitGitGadget, May 15, 2025
  8. Junio C HamanoMay 15, 2025
  9. 04/14 unparse_commit(): defensive programmingJohannes Schindelin via GitGitGadget, May 15, 2025
  10. 05/14 verify_commit_graph(): defensive programmingJohannes Schindelin via GitGitGadget, May 15, 2025
  11. 06/14 stash: defensive programmingJohannes Schindelin via GitGitGadget, May 15, 2025
  12. 07/14 stash: defensive programmingJohannes Schindelin via GitGitGadget, May 15, 2025
  13. 08/14 push: defensive programmingJohannes Schindelin via GitGitGadget, May 15, 2025
  14. 09/14 fetch: defensive programmingJohannes Schindelin via GitGitGadget, May 15, 2025
  15. 10/14 describe: defensive programmingJohannes Schindelin via GitGitGadget, May 15, 2025
  16. 11/14 inherit_tracking(): defensive programmingJohannes Schindelin via GitGitGadget, May 15, 2025
  17. 12/14 submodule: check return value of `submodule_from_path()`Johannes Schindelin via GitGitGadget, May 15, 2025
  18. 13/14 test-tool repository: check return value of `lookup_commit()`Johannes Schindelin via GitGitGadget, May 15, 2025
  19. 14/14 shallow: handle missing shallow commits gracefullyJohannes Schindelin via GitGitGadget, May 15, 2025

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.