Worktree implementation#3436
Conversation
There was a problem hiding this comment.
I suspect that we should give this a more meaningful name. (And the is_symbolic_ref function, also, below.) You could have a symbolic ref refs/heads/foo -> refs/heads/bar, which would be in the commondir not the gitdir.
I don't have any brilliant ideas though. Special refs? Local refs? Workdir refs?
There was a problem hiding this comment.
Maybe something like uncommon_refs, as those would not be stored in the common directory. Not exactly happy with this name, though, but I'd prefer either this or workdir_refs.
There was a problem hiding this comment.
I think that these are often referred to as pseudorefs in git, or per-worktree refs, as they exist at the top level and exist for each worktree.
There was a problem hiding this comment.
I've removed this array altogether as there is currently only one per-worktree ref that needs to be handled this way, which is HEAD. I've also renamed is_symbolic_ref to is_per_worktree_ref.
|
Nice! I'm happy to see that you decided to tackle this, and it looks like this is going to be a nice and clean implementation. I made a couple of minor comments, but I like where this is going. |
|
Eh. I've already fixed some issues you mention, especially the link-path being relative. Seems I've got an out of date branch on this computer. |
There was a problem hiding this comment.
Is this seems to be missing MERGE_HEAD and FETCH_HEAD, or are those handled differently? Is there really a list of these or should we perform the {_,}HEAD suffix check like we do to determine if we want to allow writing to a particular ref?
There was a problem hiding this comment.
Well, those aren't really refs, per se, they're sort of ref-like but in a non-ref irregular format and should be outside the scope of the refdb.
Though to be completely honest, I would have expected the same was true for ORIG_HEAD. Do we really use the refdb infrastructure for ORIG_HEAD?
0d63263 to
a5bfd68
Compare
|
Rebase onto master and fixed the absolute gitdir path. No changes yet besides that. |
4ac0a0b to
1b7ea2a
Compare
6e9b4aa to
71f82df
Compare
|
I've done some bugfixing, cleanup and further implementation now. As far as opening and acting on worktree-repositories goes I'm currently not aware of any gaping holes, at least it seems to work fine now. Object store, packed refs, loose refs, reflog and configs are all accessible and seem to work, even though I did not yet do any major testing (will do that when I consider this feature ready). In addition to One more missing thing is preventing the user from checking out branches that are already checked out by any worktree, as upstream git does. Guess I'll add a ref-field to I think the current state (excluding items that are still todo and the WIP-commit) is somewhat sane and cleaned up, so I'd appreciate some feedback. |
71f82df to
7550cf6
Compare
|
Meh... will fix some time later this week. |
|
sigh No luck for me, I guess. Seems as if AppVeyor is having a hiccup right now. |
7a3cf8d to
aa5a48b
Compare
f60a3fb to
b69d987
Compare
|
I consider this branch feature complete now. Some points that remain:
@ethomson @carlosmn I'd appreciate if you could review the changes as soon as you find the time to do so. |
A repository's configuartion file can always be found in the GIT_COMMON_DIR, which has been newly introduced. For normal repositories this does change nothing, but for working trees this change allows to access the shared configuration file.
Expose the function `repo_init_create_head` as `git_repository_create_head`.
Add new module for working trees with the `git_worktree_list` function. The function lists names for all working trees of a certain repository.
Introduce a new `struct git_worktree`, which holds information about a possible working tree connected to a repository. Introduce functions to allow opening working trees for a repository.
Add function `git_repository_open_from_worktree`, which allows to open a `git_worktree` as repository.
Add a new function that checks wether a given `struct git_worktree` is valid. The validation includes checking if the gitdir, parent directory and common directory are present.
Implement the `git_worktree_add` function which can be used to create new working trees for a given repository.
Working trees support locking by creating a file `locked` inside the tree's gitdir with an optional reason inside. Support this feature by adding functions to get and set the locking status.
Implement the `git_worktree_prune` function. This function can be used to delete working trees from a repository. According to the flags passed to it, it can either delete the working tree's gitdir only or both gitdir and the working directory.
Implement `git_repository_head_for_worktree` and `git_repository_head_detached_for_worktree` for directly accessing a worktree's HEAD without opening it as a `git_repository` first.
Implement a new function that is able to determine if a branch is checked out in any repository connected to the current repository. In particular, this is required to check if for a given repository and branch, there exists any working tree connected to that repository that is referencing this branch.
Restrict the ability to delete branches that are checked out in any linked repository.
If a branch is already checked out in a working tree we are not allowed to check out that branch in another repository. Introduce this restriction when setting a repository's HEAD.
The `path_repository` variable is actually confusing to think about, as it is not always clear what the repository actually is. It may either be the path to the folder containing worktree and .git directory, the path to .git itself, a worktree or something entirely different. Actually, the intent of the variable is to hold the path to the gitdir, which is either the .git directory or the bare repository. Rename the variable to `gitdir` to avoid confusion. While at it, also rename `path_gitlink` to `gitlink` to improve consistency.
When opening a worktree via the gitdir of its parent repository we fail to correctly set up the worktree's working directory. The problem here is two-fold: we first fail to see that the gitdir actually is a gitdir of a working tree and then subsequently fail to determine the working tree location from the gitdir. The first problem of not noticing a gitdir belongs to a worktree can be solved by checking for the existence of a `gitdir` file in the gitdir. This file points back to the gitlink file located in the working tree's working directory. As this file only exists for worktrees, it should be sufficient indication of the gitdir belonging to a worktree. The second problem, that is determining the location of the worktree's working directory, can then be solved by reading the `gitdir` file in the working directory's gitdir. When we now resolve relative paths and strip the final `.git` component, we have the actual worktree's working directory location.
5313037 to
1ba242c
Compare
|
🎉 Thanks again @pks-t !!! |

These patches introduce initial support for work trees, which have been introduced with git v.2.5.
Criticism and proposals welcome.
Things that need to be tackled in order to work with $COMMONDIR:
The following directories are not really used by us but would require to be made aware of $COMMONDIR:
Additional things that need to be cared about:
git_branch_deletefunction)