Skip to content
  • Duy Nguyen's avatar
    $GIT_COMMON_DIR: a new environment variable · c7b3a3d2
    Duy Nguyen authored and Junio C Hamano's avatar Junio C Hamano committed
    
    
    This variable is intended to support multiple working directories
    attached to a repository. Such a repository may have a main working
    directory, created by either "git init" or "git clone" and one or more
    linked working directories. These working directories and the main
    repository share the same repository directory.
    
    In linked working directories, $GIT_COMMON_DIR must be defined to point
    to the real repository directory and $GIT_DIR points to an unused
    subdirectory inside $GIT_COMMON_DIR. File locations inside the
    repository are reorganized from the linked worktree view point:
    
     - worktree-specific such as HEAD, logs/HEAD, index, other top-level
       refs and unrecognized files are from $GIT_DIR.
    
     - the rest like objects, refs, info, hooks, packed-refs, shallow...
       are from $GIT_COMMON_DIR (except info/sparse-checkout, but that's
       a separate patch)
    
    Scripts are supposed to retrieve paths in $GIT_DIR with "git rev-parse
    --git-path", which will take care of "$GIT_DIR vs $GIT_COMMON_DIR"
    business.
    
    The redirection is done by git_path(), git_pathdup() and
    strbuf_git_path(). The selected list of paths goes to $GIT_COMMON_DIR,
    not the other way around in case a developer adds a new
    worktree-specific file and it's accidentally promoted to be shared
    across repositories (this includes unknown files added by third party
    commands)
    
    The list of known files that belong to $GIT_DIR are:
    
    ADD_EDIT.patch BISECT_ANCESTORS_OK BISECT_EXPECTED_REV BISECT_LOG
    BISECT_NAMES CHERRY_PICK_HEAD COMMIT_MSG FETCH_HEAD HEAD MERGE_HEAD
    MERGE_MODE MERGE_RR NOTES_EDITMSG NOTES_MERGE_WORKTREE ORIG_HEAD
    REVERT_HEAD SQUASH_MSG TAG_EDITMSG fast_import_crash_* logs/HEAD
    next-index-* rebase-apply rebase-merge rsync-refs-* sequencer/*
    shallow_*
    
    Path mapping is NOT done for git_path_submodule(). Multi-checkouts are
    not supported as submodules.
    
    Helped-by: default avatarJens Lehmann <Jens.Lehmann@web.de>
    Signed-off-by: default avatarNguyễn Thái Ngọc Duy <pclouds@gmail.com>
    Signed-off-by: default avatarJunio C Hamano <gitster@pobox.com>
    c7b3a3d2