From 30ca07a249744e57163c02250fca420cea364299 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Sat, 31 Mar 2007 23:09:02 -0700 Subject: [PATCH 1/2] _GIT_INDEX_OUTPUT: allow plumbing to output to an alternative index file. When defined, this allows plumbing commands that update the index (add, apply, checkout-index, merge-recursive, mv, read-tree, rm, update-index, and write-tree) to write their resulting index to an alternative index file while holding a lock to the original index file. With this, git-commit that jumps the index does not have to make an extra copy of the index file, and more importantly, it can do the update while holding the lock on the index. However, I think the interface to let an environment variable specify the output is a mistake, as shown in the documentation. If a curious user has the environment variable set to something other than the file GIT_INDEX_FILE points at, almost everything will break. This should instead be a command line parameter to tell these plumbing commands to write the result in the named file, to prevent stupid mistakes. Signed-off-by: Junio C Hamano --- Documentation/git.txt | 8 ++++++++ builtin-add.c | 4 ++-- builtin-apply.c | 6 +++--- builtin-checkout-index.c | 7 ++----- builtin-mv.c | 4 ++-- builtin-read-tree.c | 4 ++-- builtin-rm.c | 4 ++-- builtin-update-index.c | 4 ++-- builtin-write-tree.c | 2 +- cache.h | 5 +++++ git-commit.sh | 4 ++-- lockfile.c | 17 +++++++++++++++++ merge-recursive.c | 4 ++-- 13 files changed, 50 insertions(+), 23 deletions(-) diff --git a/Documentation/git.txt b/Documentation/git.txt index 9defc3327..8fa1a0a58 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -315,6 +315,14 @@ git so take care if using Cogito etc. index file. If not specified, the default of `$GIT_DIR/index` is used. +'_GIT_INDEX_OUTPUT':: + When this environment is defined, plumbing level + commands that update the index writes the resulting + index to this file, instead of `$GIT_INDEX_FILE` (or its + default `$GIT_DIR/index`). This is solely meant to be + used by Porcelain to drive low-level plumbing. Defining + this in user's environment is always an error. + 'GIT_OBJECT_DIRECTORY':: If the object storage directory is specified via this environment variable then the sha1 directories are created diff --git a/builtin-add.c b/builtin-add.c index 9fcf514db..54422d84a 100644 --- a/builtin-add.c +++ b/builtin-add.c @@ -133,7 +133,7 @@ int cmd_add(int argc, const char **argv, const char *prefix) git_config(git_add_config); - newfd = hold_lock_file_for_update(&lock_file, get_index_file(), 1); + newfd = hold_locked_index(&lock_file, 1); for (i = 1; i < argc; i++) { const char *arg = argv[i]; @@ -209,7 +209,7 @@ int cmd_add(int argc, const char **argv, const char *prefix) if (active_cache_changed) { if (write_cache(newfd, active_cache, active_nr) || - close(newfd) || commit_lock_file(&lock_file)) + close(newfd) || commit_locked_index(&lock_file)) die("Unable to write new index file"); } diff --git a/builtin-apply.c b/builtin-apply.c index 27a182bfa..12011c1c9 100644 --- a/builtin-apply.c +++ b/builtin-apply.c @@ -2664,8 +2664,8 @@ static int apply_patch(int fd, const char *filename, int inaccurate_eof) write_index = check_index && apply; if (write_index && newfd < 0) - newfd = hold_lock_file_for_update(&lock_file, - get_index_file(), 1); + newfd = hold_locked_index(&lock_file, 1); + if (check_index) { if (read_cache() < 0) die("unable to read index file"); @@ -2872,7 +2872,7 @@ int cmd_apply(int argc, const char **argv, const char *unused_prefix) if (write_index) { if (write_cache(newfd, active_cache, active_nr) || - close(newfd) || commit_lock_file(&lock_file)) + close(newfd) || commit_locked_index(&lock_file)) die("Unable to write new index file"); } diff --git a/builtin-checkout-index.c b/builtin-checkout-index.c index afe4b0e45..8460f97b6 100644 --- a/builtin-checkout-index.c +++ b/builtin-checkout-index.c @@ -202,10 +202,7 @@ int cmd_checkout_index(int argc, const char **argv, const char *prefix) if (!strcmp(arg, "-u") || !strcmp(arg, "--index")) { state.refresh_cache = 1; if (newfd < 0) - newfd = hold_lock_file_for_update - (&lock_file, get_index_file(), 1); - if (newfd < 0) - die("cannot open index.lock file."); + newfd = hold_locked_index(&lock_file, 1); continue; } if (!strcmp(arg, "-z")) { @@ -302,7 +299,7 @@ int cmd_checkout_index(int argc, const char **argv, const char *prefix) if (0 <= newfd && (write_cache(newfd, active_cache, active_nr) || - close(newfd) || commit_lock_file(&lock_file))) + close(newfd) || commit_locked_index(&lock_file))) die("Unable to write new index file"); return 0; } diff --git a/builtin-mv.c b/builtin-mv.c index 737af350b..820aca122 100644 --- a/builtin-mv.c +++ b/builtin-mv.c @@ -77,7 +77,7 @@ int cmd_mv(int argc, const char **argv, const char *prefix) git_config(git_default_config); - newfd = hold_lock_file_for_update(&lock_file, get_index_file(), 1); + newfd = hold_locked_index(&lock_file, 1); if (read_cache() < 0) die("index file corrupt"); @@ -285,7 +285,7 @@ int cmd_mv(int argc, const char **argv, const char *prefix) if (active_cache_changed) { if (write_cache(newfd, active_cache, active_nr) || close(newfd) || - commit_lock_file(&lock_file)) + commit_locked_index(&lock_file)) die("Unable to write new index file"); } } diff --git a/builtin-read-tree.c b/builtin-read-tree.c index 793eae0a5..87048f82e 100644 --- a/builtin-read-tree.c +++ b/builtin-read-tree.c @@ -100,7 +100,7 @@ int cmd_read_tree(int argc, const char **argv, const char *unused_prefix) setup_git_directory(); git_config(git_default_config); - newfd = hold_lock_file_for_update(&lock_file, get_index_file(), 1); + newfd = hold_locked_index(&lock_file, 1); git_config(git_default_config); @@ -267,7 +267,7 @@ int cmd_read_tree(int argc, const char **argv, const char *unused_prefix) } if (write_cache(newfd, active_cache, active_nr) || - close(newfd) || commit_lock_file(&lock_file)) + close(newfd) || commit_locked_index(&lock_file)) die("unable to write new index file"); return 0; } diff --git a/builtin-rm.c b/builtin-rm.c index bf42003a7..8a0738f83 100644 --- a/builtin-rm.c +++ b/builtin-rm.c @@ -110,7 +110,7 @@ int cmd_rm(int argc, const char **argv, const char *prefix) git_config(git_default_config); - newfd = hold_lock_file_for_update(&lock_file, get_index_file(), 1); + newfd = hold_locked_index(&lock_file, 1); if (read_cache() < 0) die("index file corrupt"); @@ -220,7 +220,7 @@ int cmd_rm(int argc, const char **argv, const char *prefix) if (active_cache_changed) { if (write_cache(newfd, active_cache, active_nr) || - close(newfd) || commit_lock_file(&lock_file)) + close(newfd) || commit_locked_index(&lock_file)) die("Unable to write new index file"); } diff --git a/builtin-update-index.c b/builtin-update-index.c index 71cef633c..84993d7c5 100644 --- a/builtin-update-index.c +++ b/builtin-update-index.c @@ -495,7 +495,7 @@ int cmd_update_index(int argc, const char **argv, const char *prefix) /* We can't free this memory, it becomes part of a linked list parsed atexit() */ lock_file = xcalloc(1, sizeof(struct lock_file)); - newfd = hold_lock_file_for_update(lock_file, get_index_file(), 0); + newfd = hold_locked_index(lock_file, 0); if (newfd < 0) lock_error = errno; @@ -661,7 +661,7 @@ int cmd_update_index(int argc, const char **argv, const char *prefix) get_index_file(), strerror(lock_error)); } if (write_cache(newfd, active_cache, active_nr) || - close(newfd) || commit_lock_file(lock_file)) + close(newfd) || commit_locked_index(lock_file)) die("Unable to write new index file"); } diff --git a/builtin-write-tree.c b/builtin-write-tree.c index 90fc1cfcf..c88bbd1b9 100644 --- a/builtin-write-tree.c +++ b/builtin-write-tree.c @@ -18,7 +18,7 @@ int write_tree(unsigned char *sha1, int missing_ok, const char *prefix) /* We can't free this memory, it becomes part of a linked list parsed atexit() */ struct lock_file *lock_file = xcalloc(1, sizeof(struct lock_file)); - newfd = hold_lock_file_for_update(lock_file, get_index_file(), 0); + newfd = hold_locked_index(lock_file, 1); entries = read_cache(); if (entries < 0) diff --git a/cache.h b/cache.h index 384b26022..59a05c1a4 100644 --- a/cache.h +++ b/cache.h @@ -147,6 +147,7 @@ enum object_type { #define DEFAULT_GIT_DIR_ENVIRONMENT ".git" #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY" #define INDEX_ENVIRONMENT "GIT_INDEX_FILE" +#define INDEX_OUTPUT_ENVIRONMENT "_GIT_INDEX_OUTPUT" #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE" #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR" #define CONFIG_ENVIRONMENT "GIT_CONFIG" @@ -212,6 +213,10 @@ struct lock_file { }; extern int hold_lock_file_for_update(struct lock_file *, const char *path, int); extern int commit_lock_file(struct lock_file *); + +extern int hold_locked_index(struct lock_file *, int); +extern int commit_locked_index(struct lock_file *); + extern void rollback_lock_file(struct lock_file *); extern int delete_ref(const char *, unsigned char *sha1); diff --git a/git-commit.sh b/git-commit.sh index 292cf967e..20c0dc806 100755 --- a/git-commit.sh +++ b/git-commit.sh @@ -370,8 +370,8 @@ t,) # the same way. if test -z "$initial_commit" then - cp "$THIS_INDEX" "$TMP_INDEX" - GIT_INDEX_FILE="$TMP_INDEX" git-read-tree -i -m HEAD + _GIT_INDEX_OUTPUT="$TMP_INDEX" \ + GIT_INDEX_FILE="$THIS_INDEX" git-read-tree -i -m HEAD else rm -f "$TMP_INDEX" fi || exit diff --git a/lockfile.c b/lockfile.c index 4824f4dc0..2023ebb6f 100644 --- a/lockfile.c +++ b/lockfile.c @@ -65,6 +65,23 @@ int commit_lock_file(struct lock_file *lk) return i; } +int hold_locked_index(struct lock_file *lk, int die_on_error) +{ + return hold_lock_file_for_update(lk, get_index_file(), die_on_error); +} + +int commit_locked_index(struct lock_file *lk) +{ + char *output = getenv(INDEX_OUTPUT_ENVIRONMENT); + if (output && *output) { + int result = rename(lk->filename, output); + lk->filename[0] = 0; + return result; + } + else + return commit_lock_file(lk); +} + void rollback_lock_file(struct lock_file *lk) { if (lk->filename[0]) diff --git a/merge-recursive.c b/merge-recursive.c index e1aebd772..f46aaae85 100644 --- a/merge-recursive.c +++ b/merge-recursive.c @@ -1378,7 +1378,7 @@ int main(int argc, char *argv[]) if (show(3)) printf("Merging %s with %s\n", branch1, branch2); - index_fd = hold_lock_file_for_update(lock, get_index_file(), 1); + index_fd = hold_locked_index(lock, 1); for (i = 0; i < bases_count; i++) { struct commit *ancestor = get_ref(bases[i]); @@ -1388,7 +1388,7 @@ int main(int argc, char *argv[]) if (active_cache_changed && (write_cache(index_fd, active_cache, active_nr) || - close(index_fd) || commit_lock_file(lock))) + close(index_fd) || commit_locked_index(lock))) die ("unable to write %s", get_index_file()); return clean ? 0: 1; From 5e7f56ac33f7a5583f9fa4e0b6088709fea7a6f8 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Sat, 31 Mar 2007 23:27:41 -0700 Subject: [PATCH 2/2] git-read-tree --index-output= This corrects the interface mistake of the previous one, and gives a command line parameter to the only plumbing command that currently needs it: "git-read-tree". We can add the calls to set_alternate_index_output() to other plumbing commands that update the index if/when needed. Signed-off-by: Junio C Hamano --- Documentation/git-read-tree.txt | 14 +++++++++++++- Documentation/git.txt | 8 -------- builtin-read-tree.c | 7 ++++++- cache.h | 2 +- git-commit.sh | 4 ++-- lockfile.c | 11 ++++++++--- 6 files changed, 30 insertions(+), 16 deletions(-) diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt index 0ff2890c7..019c8bef7 100644 --- a/Documentation/git-read-tree.txt +++ b/Documentation/git-read-tree.txt @@ -8,7 +8,7 @@ git-read-tree - Reads tree information into the index SYNOPSIS -------- -'git-read-tree' ( | [[-m [--aggressive] | --reset | --prefix=] [-u | -i]] [--exclude-per-directory=] [ []]) +'git-read-tree' ( | [[-m [--aggressive] | --reset | --prefix=] [-u | -i]] [--exclude-per-directory=] [--index-output=] [ []]) DESCRIPTION @@ -86,6 +86,18 @@ OPTIONS file (usually '.gitignore') and allows such an untracked but explicitly ignored file to be overwritten. +--index-output=:: + Instead of writing the results out to `$GIT_INDEX_FILE`, + write the resulting index in the named file. While the + command is operating, the original index file is locked + with the same mechanism as usual. The file must allow + to be rename(2)ed into from a temporary file that is + created next to the usual index file; typically this + means it needs to be on the same filesystem as the index + file itself, and you need write permission to the + directories the index file and index output file are + located in. + :: The id of the tree object(s) to be read/merged. diff --git a/Documentation/git.txt b/Documentation/git.txt index 8fa1a0a58..9defc3327 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -315,14 +315,6 @@ git so take care if using Cogito etc. index file. If not specified, the default of `$GIT_DIR/index` is used. -'_GIT_INDEX_OUTPUT':: - When this environment is defined, plumbing level - commands that update the index writes the resulting - index to this file, instead of `$GIT_INDEX_FILE` (or its - default `$GIT_DIR/index`). This is solely meant to be - used by Porcelain to drive low-level plumbing. Defining - this in user's environment is always an error. - 'GIT_OBJECT_DIRECTORY':: If the object storage directory is specified via this environment variable then the sha1 directories are created diff --git a/builtin-read-tree.c b/builtin-read-tree.c index 87048f82e..213bd93c7 100644 --- a/builtin-read-tree.c +++ b/builtin-read-tree.c @@ -84,7 +84,7 @@ static void prime_cache_tree(void) } -static const char read_tree_usage[] = "git-read-tree ( | [[-m [--aggressive] | --reset | --prefix=] [-u | -i]] [--exclude-per-directory=] [ []])"; +static const char read_tree_usage[] = "git-read-tree ( | [[-m [--aggressive] | --reset | --prefix=] [-u | -i]] [--exclude-per-directory=] [--index-output=] [ []])"; static struct lock_file lock_file; @@ -128,6 +128,11 @@ int cmd_read_tree(int argc, const char **argv, const char *unused_prefix) continue; } + if (!prefixcmp(arg, "--index-output=")) { + set_alternate_index_output(arg + 15); + continue; + } + /* "--prefix=/" means keep the current index * entries and put the entries from the tree under the * given subdirectory. diff --git a/cache.h b/cache.h index 59a05c1a4..592331f70 100644 --- a/cache.h +++ b/cache.h @@ -147,7 +147,6 @@ enum object_type { #define DEFAULT_GIT_DIR_ENVIRONMENT ".git" #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY" #define INDEX_ENVIRONMENT "GIT_INDEX_FILE" -#define INDEX_OUTPUT_ENVIRONMENT "_GIT_INDEX_OUTPUT" #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE" #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR" #define CONFIG_ENVIRONMENT "GIT_CONFIG" @@ -216,6 +215,7 @@ extern int commit_lock_file(struct lock_file *); extern int hold_locked_index(struct lock_file *, int); extern int commit_locked_index(struct lock_file *); +extern void set_alternate_index_output(const char *); extern void rollback_lock_file(struct lock_file *); extern int delete_ref(const char *, unsigned char *sha1); diff --git a/git-commit.sh b/git-commit.sh index 20c0dc806..9e0959aec 100755 --- a/git-commit.sh +++ b/git-commit.sh @@ -370,8 +370,8 @@ t,) # the same way. if test -z "$initial_commit" then - _GIT_INDEX_OUTPUT="$TMP_INDEX" \ - GIT_INDEX_FILE="$THIS_INDEX" git-read-tree -i -m HEAD + GIT_INDEX_FILE="$THIS_INDEX" \ + git-read-tree --index-output="$TMP_INDEX" -i -m HEAD else rm -f "$TMP_INDEX" fi || exit diff --git a/lockfile.c b/lockfile.c index 2023ebb6f..bed6b21da 100644 --- a/lockfile.c +++ b/lockfile.c @@ -4,6 +4,7 @@ #include "cache.h" static struct lock_file *lock_file_list; +static const char *alternate_index_output; static void remove_lock_file(void) { @@ -70,11 +71,15 @@ int hold_locked_index(struct lock_file *lk, int die_on_error) return hold_lock_file_for_update(lk, get_index_file(), die_on_error); } +void set_alternate_index_output(const char *name) +{ + alternate_index_output = name; +} + int commit_locked_index(struct lock_file *lk) { - char *output = getenv(INDEX_OUTPUT_ENVIRONMENT); - if (output && *output) { - int result = rename(lk->filename, output); + if (alternate_index_output) { + int result = rename(lk->filename, alternate_index_output); lk->filename[0] = 0; return result; }