Thanks Martin and Junio for the comments on the previous round.
Changes compared to the previous round:
- Document that when failing to refresh the index, the result won't be
written to disk.
- Rollback the lock file if refreshing the index fails, so we don't
end up with a lock file that can't be rolled back or committed after
the function returns
- Some small tweaks in the commit message and documentation of the
function.
Range-diff below:
1: 1f25fe227c ! 1: 7cc9f5fff4 factor out refresh_and_write_cache function
@@ Commit message
factor out refresh_and_write_cache function
Getting the lock for the index, refreshing it and then writing it is a
- pattern that happens more than once throughout the codebase. Factor
- out the refresh_and_write_cache function from builtin/am.c to
- read-cache.c, so it can be re-used in other places in a subsequent
- commit.
+ pattern that happens more than once throughout the codebase, and isn't
+ trivial to get right. Factor out the refresh_and_write_cache function
+ from builtin/am.c to read-cache.c, so it can be re-used in other
+ places in a subsequent commit.
Note that we return different error codes for failing to refresh the
cache, and failing to write the index. The current caller only cares
@@ cache.h: void fill_stat_cache_info(struct index_state *istate, struct
cache_entr
+ * 'COMMIT_LOCK | write_flags' is passed to 'write_locked_index()', so
+ * the lockfile is always either committed or rolled back.
+ *
-+ * Return 1 if refreshing the cache failed, -1 if writing the cache to
-+ * disk failed, 0 on success.
++ * Return 1 if refreshing the index returns an error, -1 if writing
++ * the index to disk fails, 0 on success.
++ *
++ * Note that if refreshing the index returns an error, we don't write
++ * the result to disk.
+ */
+int repo_refresh_and_write_index(struct repository*, unsigned int
refresh_flags, unsigned int write_flags, const struct pathspec *, char *seen,
const char *header_msg);
+
@@ read-cache.c: static void show_file(const char * fmt, const char * name,
int in_
+ struct lock_file lock_file = LOCK_INIT;
+
+ repo_hold_locked_index(repo, &lock_file, LOCK_DIE_ON_ERROR);
-+ if (refresh_index(repo->index, refresh_flags, pathspec, seen,
header_msg))
++ if (refresh_index(repo->index, refresh_flags, pathspec, seen,
header_msg)) {
++ rollback_lock_file(&lock_file);
+ return 1;
++ }
+ if (write_locked_index(repo->index, &lock_file, COMMIT_LOCK |
write_flags))
+ return -1;
+ return 0;
2: 148a65d649 = 2: 0367d938b1 merge: use refresh_and_write_cache
3: e0f6815192 = 3: 8ed3df9fec stash: make sure to write refreshed cache
Thomas Gummerer (3):
factor out refresh_and_write_cache function
merge: use refresh_and_write_cache
stash: make sure to write refreshed cache
builtin/am.c | 16 ++--------------
builtin/merge.c | 13 +++----------
builtin/stash.c | 11 +++++++----
cache.h | 16 ++++++++++++++++
read-cache.c | 19 +++++++++++++++++++
t/t3903-stash.sh | 16 ++++++++++++++++
6 files changed, 63 insertions(+), 28 deletions(-)
--
2.23.0.rc2.194.ge5444969c9
