From 30ca07a249744e57163c02250fca420cea364299 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Sat, 31 Mar 2007 23:09:02 -0700 Subject: _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 ++++++++ 1 file changed, 8 insertions(+) (limited to 'Documentation') 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 -- cgit v1.2.1