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

[PATCH v3 6/8] builtin/ls-files: stop using `the_repository`

From
Usman Akinyemi <usmanakinyemi202@gmail.com>
Date
Mar 6, 2025, 14:35 UTC
Message-ID
<20250306143629.1267358-7-usmanakinyemi202@gmail.com>
In-Reply-To
<20250306143629.1267358-1-usmanakinyemi202@gmail.com>

Remove the_repository global variable in favor of the repository argument that gets passed in "builtin/ls-files.c".

When `-h` is passed to the command outside a Git repository, the `run_builtin()` will call the `cmd_ls_files()` function with `repo` set to NULL and then early in the function, `show_usage_with_options_if_asked()` call will give the options help and exit.

Pass the repository available in the calling context to both `expand_objectsize()` and `show_ru_info()` to remove their dependency on the global `the_repository` variable.

Mentored-by: Christian Couder <chriscool@tuxfamily.org>
Signed-off-by: Usman Akinyemi <usmanakinyemi202@gmail.com>
---
 builtin/ls-files.c        | 32 ++++++++++++++++----------------
 t/t3004-ls-files-basic.sh |  7 +++++++
 2 files changed, 23 insertions(+), 16 deletions(-)
diff --git a/builtin/ls-files.c b/builtin/ls-files.c
index a4431429b7..70a377e9c0 100644
--- a/builtin/ls-files.c
+++ b/builtin/ls-files.c
@@ -6,7 +6,6 @@
  * Copyright (C) Linus Torvalds, 2005
  */
 
-#define USE_THE_REPOSITORY_VARIABLE
 #define DISABLE_SIGN_COMPARE_WARNINGS
 
 #include "builtin.h"
@@ -245,12 +244,13 @@ static void show_submodule(struct repository *superproject,
 	repo_clear(&subrepo);
 }
 
-static void expand_objectsize(struct strbuf *line, const struct object_id *oid,
+static void expand_objectsize(struct repository *repo, struct strbuf *line,
+			      const struct object_id *oid,
 			      const enum object_type type, unsigned int padded)
 {
 	if (type == OBJ_BLOB) {
 		unsigned long size;
-		if (oid_object_info(the_repository, oid, &size) < 0)
+		if (oid_object_info(repo, oid, &size) < 0)
 			die(_("could not get object info about '%s'"),
 			    oid_to_hex(oid));
 		if (padded)
@@ -283,10 +283,10 @@ static void show_ce_fmt(struct repository *repo, const struct cache_entry *ce,
 		else if (skip_prefix(format, "(objecttype)", &format))
 			strbuf_addstr(&sb, type_name(object_type(ce->ce_mode)));
 		else if (skip_prefix(format, "(objectsize:padded)", &format))
-			expand_objectsize(&sb, &ce->oid,
+			expand_objectsize(repo, &sb, &ce->oid,
 					  object_type(ce->ce_mode), 1);
 		else if (skip_prefix(format, "(objectsize)", &format))
-			expand_objectsize(&sb, &ce->oid,
+			expand_objectsize(repo, &sb, &ce->oid,
 					  object_type(ce->ce_mode), 0);
 		else if (skip_prefix(format, "(stage)", &format))
 			strbuf_addf(&sb, "%d", ce_stage(ce));
@@ -348,7 +348,7 @@ static void show_ce(struct repository *repo, struct dir_struct *dir,
 	}
 }
 
-static void show_ru_info(struct index_state *istate)
+static void show_ru_info(struct repository *repo, struct index_state *istate)
 {
 	struct string_list_item *item;
 
@@ -370,7 +370,7 @@ static void show_ru_info(struct index_state *istate)
 			if (!ui->mode[i])
 				continue;
 			printf("%s%06o %s %d\t", tag_resolve_undo, ui->mode[i],
-			       repo_find_unique_abbrev(the_repository, &ui->oid[i], abbrev),
+			       repo_find_unique_abbrev(repo, &ui->oid[i], abbrev),
 			       i + 1);
 			write_name(path);
 		}
@@ -567,7 +567,7 @@ static int option_parse_exclude_standard(const struct option *opt,
 int cmd_ls_files(int argc,
 		 const char **argv,
 		 const char *cmd_prefix,
-		 struct repository *repo UNUSED)
+		 struct repository *repo)
 {
 	int require_work_tree = 0, show_tag = 0, i;
 	char *max_prefix;
@@ -647,15 +647,15 @@ int cmd_ls_files(int argc,
 	show_usage_with_options_if_asked(argc, argv,
 					 ls_files_usage, builtin_ls_files_options);
 
-	prepare_repo_settings(the_repository);
-	the_repository->settings.command_requires_full_index = 0;
+	prepare_repo_settings(repo);
+	repo->settings.command_requires_full_index = 0;
 
 	prefix = cmd_prefix;
 	if (prefix)
 		prefix_len = strlen(prefix);
-	git_config(git_default_config, NULL);
+	repo_config(repo, git_default_config, NULL);
 
-	if (repo_read_index(the_repository) < 0)
+	if (repo_read_index(repo) < 0)
 		die("index file corrupt");
 
 	argc = parse_options(argc, argv, prefix, builtin_ls_files_options,
@@ -724,7 +724,7 @@ int cmd_ls_files(int argc,
 		max_prefix = common_prefix(&pathspec);
 	max_prefix_len = get_common_prefix_len(max_prefix);
 
-	prune_index(the_repository->index, max_prefix, max_prefix_len);
+	prune_index(repo->index, max_prefix, max_prefix_len);
 
 	/* Treat unmatching pathspec elements as errors */
 	if (pathspec.nr && error_unmatch)
@@ -748,13 +748,13 @@ int cmd_ls_files(int argc,
 		 */
 		if (show_stage || show_unmerged)
 			die(_("options '%s' and '%s' cannot be used together"), "ls-files --with-tree", "-s/-u");
-		overlay_tree_on_index(the_repository->index, with_tree, max_prefix);
+		overlay_tree_on_index(repo->index, with_tree, max_prefix);
 	}
 
-	show_files(the_repository, &dir);
+	show_files(repo, &dir);
 
 	if (show_resolve_undo)
-		show_ru_info(the_repository->index);
+		show_ru_info(repo, repo->index);
 
 	if (ps_matched && report_path_error(ps_matched, &pathspec)) {
 		fprintf(stderr, "Did you forget to 'git add'?\n");
diff --git a/t/t3004-ls-files-basic.sh b/t/t3004-ls-files-basic.sh
index a1078f8701..4034a5a59f 100755
--- a/t/t3004-ls-files-basic.sh
+++ b/t/t3004-ls-files-basic.sh
@@ -34,6 +34,13 @@ test_expect_success 'ls-files -h in corrupt repository' '
 	test_grep "[Uu]sage: git ls-files " broken/usage
 '
 
+test_expect_success 'ls-files does not crash with -h' '
+	test_expect_code 129 git ls-files -h >usage &&
+	test_grep "[Uu]sage: git ls-files " usage &&
+	test_expect_code 129 nongit git ls-files -h >usage &&
+	test_grep "[Uu]sage: git ls-files " usage
+'
+
 test_expect_success SYMLINKS 'ls-files with absolute paths to symlinks' '
 	mkdir subs &&
 	ln -s nosuch link &&
-- 
2.48.1
Previous: Usman AkinyemiNext: Junio C Hamano
Message 47 of 63 in “[Outreachy] stop using the_repository global variable.”
  1. 0/7 [Outreachy] stop using the_repository global variable.Usman Akinyemi, Feb 14, 2025
  2. 1/7 builtin/verify-tag: stop using `the_repository`Usman Akinyemi, Feb 14, 2025
  3. Patrick SteinhardtFeb 17, 2025
  4. Usman AkinyemiFeb 17, 2025
  5. Patrick SteinhardtFeb 17, 2025
  6. Usman AkinyemiFeb 17, 2025
  7. Patrick SteinhardtFeb 17, 2025
  8. 2/7 builtin/verify-commit.c: stop using `the_repository`Usman Akinyemi, Feb 14, 2025
  9. shejialuoFeb 16, 2025
  10. Usman AkinyemiFeb 17, 2025
  11. 3/7 builtin/send-pack.c: stop using `the_repository`Usman Akinyemi, Feb 14, 2025
  12. 4/7 builtin/pack-refs: stop using `the_repository`Usman Akinyemi, Feb 14, 2025
  13. 5/7 builtin/ls-files: stop using `the_repository`Usman Akinyemi, Feb 14, 2025
  14. Patrick SteinhardtFeb 17, 2025
  15. Usman AkinyemiFeb 17, 2025
  16. 6/7 builtin/for-each-ref: stop using `the_repository`Usman Akinyemi, Feb 14, 2025
  17. 7/7 builtin/checkout-index.c: stop using `the_repository`Usman Akinyemi, Feb 14, 2025
  18. shejialuoFeb 16, 2025
  19. Usman AkinyemiFeb 17, 2025
  20. 00/12 [Outreachy] stop using the_repository global variable.Usman Akinyemi, Feb 19, 2025
  21. 01/12 builtin/verify-tag: refactor `cmd_verify_tag()`Usman Akinyemi, Feb 19, 2025
  22. Junio C HamanoFeb 20, 2025
  23. 02/12 builtin/verify-tag: stop using `the_repository`Usman Akinyemi, Feb 19, 2025
  24. Junio C HamanoFeb 20, 2025
  25. Usman AkinyemiFeb 27, 2025
  26. Junio C HamanoFeb 27, 2025
  27. 03/12 builtin/verify-commit: refactor `cmd_verify_commit()`Usman Akinyemi, Feb 19, 2025
  28. 04/12 builtin/verify-commit: stop using `the_repository`Usman Akinyemi, Feb 19, 2025
  29. 05/12 builtin/send-pack: refactor `cmd_send_pack()`Usman Akinyemi, Feb 19, 2025
  30. 06/12 builtin/send-pack: stop using `the_repository`Usman Akinyemi, Feb 19, 2025
  31. 07/12 builtin/pack-refs: refactor `cmd_pack_refs()`Usman Akinyemi, Feb 19, 2025
  32. 08/12 builtin/pack-refs: stop using `the_repository`Usman Akinyemi, Feb 19, 2025
  33. 09/12 builtin/ls-files: stop using `the_repository`Usman Akinyemi, Feb 19, 2025
  34. 10/12 builtin/for-each-ref: refactor `cmd_for_each_ref()`Usman Akinyemi, Feb 19, 2025
  35. 11/12 builtin/for-each-ref: stop using `the_repository`Usman Akinyemi, Feb 19, 2025
  36. 12/12 builtin/checkout-index: stop using `the_repository`Usman Akinyemi, Feb 19, 2025
  37. 0/8 stop using the_repository global variable.Usman Akinyemi, Mar 6, 2025
  38. 1/8 config: teach repo_config to allow `repo` to be NULLUsman Akinyemi, Mar 6, 2025
  39. Junio C HamanoMar 6, 2025
  40. Usman AkinyemiMar 7, 2025
  41. Phillip WoodMar 7, 2025
  42. 2/8 builtin/verify-tag: stop using `the_repository`Usman Akinyemi, Mar 6, 2025
  43. Junio C HamanoMar 6, 2025
  44. 3/8 builtin/verify-commit: stop using `the_repository`Usman Akinyemi, Mar 6, 2025
  45. 4/8 builtin/send-pack: stop using `the_repository`Usman Akinyemi, Mar 6, 2025
  46. 5/8 builtin/pack-refs: stop using `the_repository`Usman Akinyemi, Mar 6, 2025
  47. 6/8 builtin/ls-files: stop using `the_repository`Usman Akinyemi, Mar 6, 2025
  48. Junio C HamanoMar 6, 2025
  49. 7/8 builtin/for-each-ref: stop using `the_repository`Usman Akinyemi, Mar 6, 2025
  50. 8/8 builtin/checkout-index: stop using `the_repository`Usman Akinyemi, Mar 6, 2025
  51. Junio C HamanoMar 6, 2025
  52. Usman AkinyemiMar 7, 2025
  53. Junio C HamanoMar 7, 2025
  54. Usman AkinyemiMar 7, 2025
  55. 0/8 stop using the_repository global variable.Usman Akinyemi, Mar 7, 2025
  56. 1/8 config: teach repo_config to allow `repo` to be NULLUsman Akinyemi, Mar 7, 2025
  57. 2/8 builtin/verify-tag: stop using `the_repository`Usman Akinyemi, Mar 7, 2025
  58. 3/8 builtin/verify-commit: stop using `the_repository`Usman Akinyemi, Mar 7, 2025
  59. 4/8 builtin/send-pack: stop using `the_repository`Usman Akinyemi, Mar 7, 2025
  60. 5/8 builtin/pack-refs: stop using `the_repository`Usman Akinyemi, Mar 7, 2025
  61. 6/8 builtin/ls-files: stop using `the_repository`Usman Akinyemi, Mar 7, 2025
  62. 7/8 builtin/for-each-ref: stop using `the_repository`Usman Akinyemi, Mar 7, 2025
  63. 8/8 builtin/checkout-index: stop using `the_repository`Usman Akinyemi, Mar 7, 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.