Git Mailing List Archive mirror
 help / color / mirror / Atom feed
From: "Elijah Newren via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: Elijah Newren <newren@gmail.com>,
	Calvin Wan <calvinwan@google.com>, Jeff King <peff@peff.net>,
	Glen Choo <chooglen@google.com>, Elijah Newren <newren@gmail.com>,
	Elijah Newren <newren@gmail.com>
Subject: [PATCH v2 06/27] add: modify add_files_to_cache() to avoid globals
Date: Fri, 12 May 2023 07:04:07 +0000	[thread overview]
Message-ID: <13d6dd1095c6dcb8030b63b83635c760737b4163.1683875070.git.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.1525.v2.git.1683875068.gitgitgadget@gmail.com>

From: Elijah Newren <newren@gmail.com>

The function add_files_to_cache() is used by all three of builtin/{add,
checkout, commit}.c.  That suggests this is common library code, and
should be moved somewhere else, like read-cache.c.  However, the
function and its helpers made use of two global variables that made
straight code movement difficult:
  * the_index
  * include_sparse
The latter was perhaps more problematic since it was only accessible in
builtin/add.c but was still affecting builtin/checkout.c and
builtin/commit.c without this fact being very clear from the code.  I'm
not sure if the other two callers would want to add a `--sparse` flag
similar to add.c to get non-default behavior, but exposing this
dependence will help if we ever decide we do want to add such a flag.

Modify add_files_to_cache() and its helpers to accept the necessary
arguments instead of relying on globals.

Signed-off-by: Elijah Newren <newren@gmail.com>
---
 builtin/add.c      | 22 +++++++++++++++-------
 builtin/checkout.c |  2 +-
 builtin/commit.c   |  3 ++-
 cache.h            |  4 +++-
 4 files changed, 21 insertions(+), 10 deletions(-)

diff --git a/builtin/add.c b/builtin/add.c
index 76cc026a68a..a526eff734e 100644
--- a/builtin/add.c
+++ b/builtin/add.c
@@ -37,6 +37,8 @@ static int include_sparse;
 static const char *pathspec_from_file;
 
 struct update_callback_data {
+	struct index_state *index;
+	int include_sparse;
 	int flags;
 	int add_errors;
 };
@@ -100,7 +102,8 @@ static void update_callback(struct diff_queue_struct *q,
 		struct diff_filepair *p = q->queue[i];
 		const char *path = p->one->path;
 
-		if (!include_sparse && !path_in_sparse_checkout(path, &the_index))
+		if (!data->include_sparse &&
+		    !path_in_sparse_checkout(path, data->index))
 			continue;
 
 		switch (fix_unmerged_status(p, data)) {
@@ -108,7 +111,7 @@ static void update_callback(struct diff_queue_struct *q,
 			die(_("unexpected diff status %c"), p->status);
 		case DIFF_STATUS_MODIFIED:
 		case DIFF_STATUS_TYPE_CHANGED:
-			if (add_file_to_index(&the_index, path,	data->flags)) {
+			if (add_file_to_index(data->index, path, data->flags)) {
 				if (!(data->flags & ADD_CACHE_IGNORE_ERRORS))
 					die(_("updating files failed"));
 				data->add_errors++;
@@ -118,7 +121,7 @@ static void update_callback(struct diff_queue_struct *q,
 			if (data->flags & ADD_CACHE_IGNORE_REMOVAL)
 				break;
 			if (!(data->flags & ADD_CACHE_PRETEND))
-				remove_file_from_index(&the_index, path);
+				remove_file_from_index(data->index, path);
 			if (data->flags & (ADD_CACHE_PRETEND|ADD_CACHE_VERBOSE))
 				printf(_("remove '%s'\n"), path);
 			break;
@@ -126,16 +129,19 @@ static void update_callback(struct diff_queue_struct *q,
 	}
 }
 
-int add_files_to_cache(const char *prefix,
-		       const struct pathspec *pathspec, int flags)
+int add_files_to_cache(struct repository *repo, const char *prefix,
+		       const struct pathspec *pathspec, int include_sparse,
+		       int flags)
 {
 	struct update_callback_data data;
 	struct rev_info rev;
 
 	memset(&data, 0, sizeof(data));
+	data.index = repo->index;
+	data.include_sparse = include_sparse;
 	data.flags = flags;
 
-	repo_init_revisions(the_repository, &rev, prefix);
+	repo_init_revisions(repo, &rev, prefix);
 	setup_revisions(0, NULL, &rev, NULL);
 	if (pathspec)
 		copy_pathspec(&rev.prune_data, pathspec);
@@ -640,7 +646,9 @@ int cmd_add(int argc, const char **argv, const char *prefix)
 	if (add_renormalize)
 		exit_status |= renormalize_tracked_files(&pathspec, flags);
 	else
-		exit_status |= add_files_to_cache(prefix, &pathspec, flags);
+		exit_status |= add_files_to_cache(the_repository, prefix,
+						  &pathspec, include_sparse,
+						  flags);
 
 	if (add_new_files)
 		exit_status |= add_files(&dir, flags);
diff --git a/builtin/checkout.c b/builtin/checkout.c
index 715eeb5048f..d6765c9dbd9 100644
--- a/builtin/checkout.c
+++ b/builtin/checkout.c
@@ -861,7 +861,7 @@ static int merge_working_tree(const struct checkout_opts *opts,
 			 * entries in the index.
 			 */
 
-			add_files_to_cache(NULL, NULL, 0);
+			add_files_to_cache(the_repository, NULL, NULL, 0, 0);
 			init_merge_options(&o, the_repository);
 			o.verbosity = 0;
 			work = write_in_core_index_as_tree(the_repository);
diff --git a/builtin/commit.c b/builtin/commit.c
index e67c4be2211..bd634ee6ad1 100644
--- a/builtin/commit.c
+++ b/builtin/commit.c
@@ -447,7 +447,8 @@ static const char *prepare_index(const char **argv, const char *prefix,
 	if (all || (also && pathspec.nr)) {
 		repo_hold_locked_index(the_repository, &index_lock,
 				       LOCK_DIE_ON_ERROR);
-		add_files_to_cache(also ? prefix : NULL, &pathspec, 0);
+		add_files_to_cache(the_repository, also ? prefix : NULL,
+				   &pathspec, 0, 0);
 		refresh_cache_or_die(refresh_flags);
 		cache_tree_update(&the_index, WRITE_TREE_SILENT);
 		if (write_locked_index(&the_index, &index_lock, 0))
diff --git a/cache.h b/cache.h
index 8b2eb52f04e..02d69c24cd6 100644
--- a/cache.h
+++ b/cache.h
@@ -554,7 +554,9 @@ int cmp_cache_name_compare(const void *a_, const void *b_);
  * return 0 if success, 1 - if addition of a file failed and
  * ADD_FILES_IGNORE_ERRORS was specified in flags
  */
-int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
+int add_files_to_cache(struct repository *repo, const char *prefix,
+		       const struct pathspec *pathspec, int include_sparse,
+		       int flags);
 
 /* diff.c */
 extern int diff_auto_refresh_index;
-- 
gitgitgadget


  parent reply	other threads:[~2023-05-12  7:05 UTC|newest]

Thread overview: 115+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-05-07  3:45 [PATCH 00/24] Header cleanups (final splitting of cache.h, and some splitting of other headers) Elijah Newren via GitGitGadget
2023-05-07  3:45 ` [PATCH 01/24] init-db: remove unnecessary global variable & document existing bug Elijah Newren via GitGitGadget
2023-05-11 17:24   ` Calvin Wan
2023-05-12  1:55     ` Elijah Newren
2023-05-11 20:43   ` Glen Choo
2023-05-12  1:21     ` Elijah Newren
2023-05-12 17:26       ` Glen Choo
2023-05-07  3:45 ` [PATCH 02/24] init-db, clone: change unnecessary global into passed parameter Elijah Newren via GitGitGadget
2023-05-07  3:45 ` [PATCH 03/24] setup: adopt shared init-db & clone code Elijah Newren via GitGitGadget
2023-05-07  3:45 ` [PATCH 04/24] read-cache: move shared commit and ls-files code Elijah Newren via GitGitGadget
2023-05-07  3:45 ` [PATCH 05/24] add: modify add_files_to_cache() to avoid globals Elijah Newren via GitGitGadget
2023-05-07  3:45 ` [PATCH 06/24] read-cache: move shared add/checkout/commit code Elijah Newren via GitGitGadget
2023-05-07  3:45 ` [PATCH 07/24] statinfo: move stat_{data,validity} functions from cache/read-cache Elijah Newren via GitGitGadget
2023-05-07  3:45 ` [PATCH 08/24] run-command.h: move declarations for run-command.c from cache.h Elijah Newren via GitGitGadget
2023-05-07  3:45 ` [PATCH 09/24] name-hash.h: move declarations for name-hash.c " Elijah Newren via GitGitGadget
2023-05-07  3:45 ` [PATCH 10/24] sparse-index.h: move declarations for sparse-index.c " Elijah Newren via GitGitGadget
2023-05-07  3:45 ` [PATCH 11/24] preload-index.h: move declarations for preload-index.c from elsewhere Elijah Newren via GitGitGadget
2023-05-07  3:45 ` [PATCH 12/24] diff.h: move declaration for global in diff.c from cache.h Elijah Newren via GitGitGadget
2023-05-07  3:45 ` [PATCH 13/24] merge.h: move declarations for merge.c " Elijah Newren via GitGitGadget
2023-05-07  3:45 ` [PATCH 14/24] repository.h: move declaration of the_index " Elijah Newren via GitGitGadget
2023-05-07  3:45 ` [PATCH 15/24] read-cache*.h: move declarations for read-cache.c functions " Elijah Newren via GitGitGadget
2023-05-07  3:45 ` [PATCH 16/24] cache.h: remove this no-longer-used header Elijah Newren via GitGitGadget
2023-05-07  3:45 ` [PATCH 17/24] log-tree: replace include of revision.h with simple forward declaration Elijah Newren via GitGitGadget
2023-05-07  3:45 ` [PATCH 18/24] repository: remove unnecessary include of path.h Elijah Newren via GitGitGadget
2023-05-07  3:45 ` [PATCH 19/24] diff.h: remove unnecessary include of oidset.h Elijah Newren via GitGitGadget
2023-05-07  3:45 ` [PATCH 20/24] list-objects-filter-options.h: remove unneccessary include Elijah Newren via GitGitGadget
2023-05-07  3:45 ` [PATCH 21/24] builtin.h: remove unneccessary includes Elijah Newren via GitGitGadget
2023-05-07  3:45 ` [PATCH 22/24] git-compat-util.h: remove unneccessary include of wildmatch.h Elijah Newren via GitGitGadget
2023-05-07  3:45 ` [PATCH 23/24] hash-ll, hashmap: move oidhash() to hash-ll Elijah Newren via GitGitGadget
2023-05-11 17:24   ` Calvin Wan
2023-05-11 18:31     ` Jeff King
2023-05-11 18:39       ` Felipe Contreras
2023-05-12  2:08       ` Elijah Newren
2023-05-12  4:07         ` Jeff King
2023-05-07  3:45 ` [PATCH 24/24] fsmonitor-ll.h: split this header out of fsmonitor.h Elijah Newren via GitGitGadget
2023-05-08 15:29 ` [PATCH 00/24] Header cleanups (final splitting of cache.h, and some splitting of other headers) Junio C Hamano
2023-05-09  1:31   ` Elijah Newren
2023-05-09 16:03     ` Junio C Hamano
2023-05-08 15:55 ` Junio C Hamano
2023-05-11 17:41 ` Calvin Wan
2023-05-12  6:58   ` Elijah Newren
2023-05-12  7:04 ` [PATCH v2 00/27] " Elijah Newren via GitGitGadget
2023-05-12  7:04   ` [PATCH v2 01/27] init-db: document existing bug with core.bare in template config Elijah Newren via GitGitGadget
2023-05-12 21:34     ` Jonathan Tan
2023-05-16  3:08       ` Elijah Newren
2023-05-12  7:04   ` [PATCH v2 02/27] init-db: remove unnecessary global variable Elijah Newren via GitGitGadget
2023-05-12 20:20     ` Glen Choo
2023-05-12  7:04   ` [PATCH v2 03/27] init-db, clone: change unnecessary global into passed parameter Elijah Newren via GitGitGadget
2023-05-12 21:28     ` Jonathan Tan
2023-05-16  2:57       ` Elijah Newren
2023-05-12  7:04   ` [PATCH v2 04/27] setup: adopt shared init-db & clone code Elijah Newren via GitGitGadget
2023-05-12  7:04   ` [PATCH v2 05/27] read-cache: move shared commit and ls-files code Elijah Newren via GitGitGadget
2023-05-12 21:25     ` Jonathan Tan
2023-05-12  7:04   ` Elijah Newren via GitGitGadget [this message]
2023-05-15 21:44     ` [PATCH v2 06/27] add: modify add_files_to_cache() to avoid globals Jonathan Tan
2023-05-12  7:04   ` [PATCH v2 07/27] read-cache: move shared add/checkout/commit code Elijah Newren via GitGitGadget
2023-05-12  7:04   ` [PATCH v2 08/27] statinfo: move stat_{data,validity} functions from cache/read-cache Elijah Newren via GitGitGadget
2023-05-12  7:04   ` [PATCH v2 09/27] run-command.h: move declarations for run-command.c from cache.h Elijah Newren via GitGitGadget
2023-05-12  7:04   ` [PATCH v2 10/27] name-hash.h: move declarations for name-hash.c " Elijah Newren via GitGitGadget
2023-05-12  7:04   ` [PATCH v2 11/27] sparse-index.h: move declarations for sparse-index.c " Elijah Newren via GitGitGadget
2023-05-12  7:04   ` [PATCH v2 12/27] preload-index.h: move declarations for preload-index.c from elsewhere Elijah Newren via GitGitGadget
2023-05-12  7:04   ` [PATCH v2 13/27] diff.h: move declaration for global in diff.c from cache.h Elijah Newren via GitGitGadget
2023-05-12  7:04   ` [PATCH v2 14/27] merge.h: move declarations for merge.c " Elijah Newren via GitGitGadget
2023-05-12  7:04   ` [PATCH v2 15/27] repository.h: move declaration of the_index " Elijah Newren via GitGitGadget
2023-05-15 21:50     ` Jonathan Tan
2023-05-12  7:04   ` [PATCH v2 16/27] read-cache*.h: move declarations for read-cache.c functions " Elijah Newren via GitGitGadget
2023-05-16  0:00     ` Jonathan Tan
2023-05-12  7:04   ` [PATCH v2 17/27] cache.h: remove this no-longer-used header Elijah Newren via GitGitGadget
2023-05-16  0:02     ` Jonathan Tan
2023-05-16  3:02       ` Elijah Newren
2023-05-12  7:04   ` [PATCH v2 18/27] log-tree: replace include of revision.h with simple forward declaration Elijah Newren via GitGitGadget
2023-05-12  7:04   ` [PATCH v2 19/27] repository: remove unnecessary include of path.h Elijah Newren via GitGitGadget
2023-05-12  7:04   ` [PATCH v2 20/27] diff.h: remove unnecessary include of oidset.h Elijah Newren via GitGitGadget
2023-05-12  7:04   ` [PATCH v2 21/27] list-objects-filter-options.h: remove unneccessary include Elijah Newren via GitGitGadget
2023-05-12  7:04   ` [PATCH v2 22/27] builtin.h: remove unneccessary includes Elijah Newren via GitGitGadget
2023-05-12  7:04   ` [PATCH v2 23/27] git-compat-util.h: remove unneccessary include of wildmatch.h Elijah Newren via GitGitGadget
2023-05-12  7:04   ` [PATCH v2 24/27] merge-ll: rename from ll-merge Elijah Newren via GitGitGadget
2023-05-12  7:04   ` [PATCH v2 25/27] khash: name the structs that khash declares Elijah Newren via GitGitGadget
2023-05-12  7:04   ` [PATCH v2 26/27] hash-ll, hashmap: move oidhash() to hash-ll Elijah Newren via GitGitGadget
2023-05-16  0:16     ` Jonathan Tan
2023-05-16  3:06       ` Elijah Newren
2023-05-12  7:04   ` [PATCH v2 27/27] fsmonitor-ll.h: split this header out of fsmonitor.h Elijah Newren via GitGitGadget
2023-05-16  0:17     ` Jonathan Tan
2023-05-16  3:07       ` Elijah Newren
2023-05-16  6:33   ` [PATCH v3 00/28] Header cleanups (final splitting of cache.h, and some splitting of other headers) Elijah Newren via GitGitGadget
2023-05-16  6:33     ` [PATCH v3 01/28] init-db: document existing bug with core.bare in template config Elijah Newren via GitGitGadget
2023-05-16  6:33     ` [PATCH v3 02/28] init-db: remove unnecessary global variable Elijah Newren via GitGitGadget
2023-05-16  6:33     ` [PATCH v3 03/28] init-db, clone: change unnecessary global into passed parameter Elijah Newren via GitGitGadget
2023-05-16  6:33     ` [PATCH v3 04/28] setup: adopt shared init-db & clone code Elijah Newren via GitGitGadget
2023-05-16  6:33     ` [PATCH v3 05/28] read-cache: move shared commit and ls-files code Elijah Newren via GitGitGadget
2023-05-16  6:33     ` [PATCH v3 06/28] add: modify add_files_to_cache() to avoid globals Elijah Newren via GitGitGadget
2023-05-16  6:33     ` [PATCH v3 07/28] read-cache: move shared add/checkout/commit code Elijah Newren via GitGitGadget
2023-05-16  6:33     ` [PATCH v3 08/28] statinfo: move stat_{data,validity} functions from cache/read-cache Elijah Newren via GitGitGadget
2023-05-16  6:33     ` [PATCH v3 09/28] run-command.h: move declarations for run-command.c from cache.h Elijah Newren via GitGitGadget
2023-05-16  6:33     ` [PATCH v3 10/28] name-hash.h: move declarations for name-hash.c " Elijah Newren via GitGitGadget
2023-05-16  6:33     ` [PATCH v3 11/28] sparse-index.h: move declarations for sparse-index.c " Elijah Newren via GitGitGadget
2023-05-16  6:33     ` [PATCH v3 12/28] preload-index.h: move declarations for preload-index.c from elsewhere Elijah Newren via GitGitGadget
2023-05-16  6:33     ` [PATCH v3 13/28] diff.h: move declaration for global in diff.c from cache.h Elijah Newren via GitGitGadget
2023-05-16  6:33     ` [PATCH v3 14/28] merge.h: move declarations for merge.c " Elijah Newren via GitGitGadget
2023-05-16  6:33     ` [PATCH v3 15/28] repository.h: move declaration of the_index " Elijah Newren via GitGitGadget
2023-05-16  6:33     ` [PATCH v3 16/28] read-cache*.h: move declarations for read-cache.c functions " Elijah Newren via GitGitGadget
2023-05-16  6:33     ` [PATCH v3 17/28] cache.h: remove this no-longer-used header Elijah Newren via GitGitGadget
2023-05-16  6:33     ` [PATCH v3 18/28] log-tree: replace include of revision.h with simple forward declaration Elijah Newren via GitGitGadget
2023-05-16  6:33     ` [PATCH v3 19/28] repository: remove unnecessary include of path.h Elijah Newren via GitGitGadget
2023-05-16  6:34     ` [PATCH v3 20/28] diff.h: remove unnecessary include of oidset.h Elijah Newren via GitGitGadget
2023-05-16  6:34     ` [PATCH v3 21/28] list-objects-filter-options.h: remove unneccessary include Elijah Newren via GitGitGadget
2023-05-16  6:34     ` [PATCH v3 22/28] builtin.h: remove unneccessary includes Elijah Newren via GitGitGadget
2023-05-16  6:34     ` [PATCH v3 23/28] git-compat-util.h: remove unneccessary include of wildmatch.h Elijah Newren via GitGitGadget
2023-05-16  6:34     ` [PATCH v3 24/28] merge-ll: rename from ll-merge Elijah Newren via GitGitGadget
2023-05-16  6:34     ` [PATCH v3 25/28] khash: name the structs that khash declares Elijah Newren via GitGitGadget
2023-05-16  6:34     ` [PATCH v3 26/28] object-store-ll.h: split this header out of object-store.h Elijah Newren via GitGitGadget
2023-05-16  6:34     ` [PATCH v3 27/28] hash-ll, hashmap: move oidhash() to hash-ll Elijah Newren via GitGitGadget
2023-05-16  6:34     ` [PATCH v3 28/28] fsmonitor-ll.h: split this header out of fsmonitor.h Elijah Newren via GitGitGadget
2023-05-23 19:49     ` [PATCH v3 00/28] Header cleanups (final splitting of cache.h, and some splitting of other headers) Calvin Wan
2023-05-24  0:11       ` Elijah Newren

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

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

  git send-email \
    --in-reply-to=13d6dd1095c6dcb8030b63b83635c760737b4163.1683875070.git.gitgitgadget@gmail.com \
    --to=gitgitgadget@gmail.com \
    --cc=calvinwan@google.com \
    --cc=chooglen@google.com \
    --cc=git@vger.kernel.org \
    --cc=newren@gmail.com \
    --cc=peff@peff.net \
    /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.
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).