mirror of
https://github.com/git/git.git
synced 2024-11-18 02:53:55 +01:00
1a248cf21d
In a later patch we want to move around the the git directory of
a submodule. Both submodules as well as worktrees are involved in
placing git directories at unusual places, so their functionality
may collide. To react appropriately to situations where worktrees
in submodules are in use, offer a new function to query the
a submodule if it uses the worktree feature.
An earlier approach:
"Implement submodule_get_worktrees and just count them", however:
This can be done cheaply (both in new code to write as well as run time)
by obtaining the list of worktrees based off that submodules git
directory. However as we have loaded the variables for the current
repository, the values in the submodule worktree
can be wrong, e.g.
* core.ignorecase may differ between these two repositories
* the ref resolution is broken (refs/heads/branch in the submodule
resolves to the sha1 value of the `branch` in the current repository
that may not exist or have another sha1)
The implementation here is just checking for any files in
$GIT_COMMON_DIR/worktrees for the submodule, which ought to be sufficient
if the submodule is using the current repository format, which we also
check.
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
85 lines
2.3 KiB
C
85 lines
2.3 KiB
C
#ifndef WORKTREE_H
|
|
#define WORKTREE_H
|
|
|
|
struct worktree {
|
|
char *path;
|
|
char *id;
|
|
char *head_ref;
|
|
char *lock_reason; /* internal use */
|
|
unsigned char head_sha1[20];
|
|
int is_detached;
|
|
int is_bare;
|
|
int is_current;
|
|
int lock_reason_valid;
|
|
};
|
|
|
|
/* Functions for acting on the information about worktrees. */
|
|
|
|
#define GWT_SORT_LINKED (1 << 0) /* keeps linked worktrees sorted */
|
|
|
|
/*
|
|
* Get the worktrees. The primary worktree will always be the first returned,
|
|
* and linked worktrees will be pointed to by 'next' in each subsequent
|
|
* worktree. No specific ordering is done on the linked worktrees.
|
|
*
|
|
* The caller is responsible for freeing the memory from the returned
|
|
* worktree(s).
|
|
*/
|
|
extern struct worktree **get_worktrees(unsigned flags);
|
|
|
|
/*
|
|
* Returns 1 if linked worktrees exist, 0 otherwise.
|
|
*/
|
|
extern int submodule_uses_worktrees(const char *path);
|
|
|
|
/*
|
|
* Return git dir of the worktree. Note that the path may be relative.
|
|
* If wt is NULL, git dir of current worktree is returned.
|
|
*/
|
|
extern const char *get_worktree_git_dir(const struct worktree *wt);
|
|
|
|
/*
|
|
* Search a worktree that can be unambiguously identified by
|
|
* "arg". "prefix" must not be NULL.
|
|
*/
|
|
extern struct worktree *find_worktree(struct worktree **list,
|
|
const char *prefix,
|
|
const char *arg);
|
|
|
|
/*
|
|
* Return true if the given worktree is the main one.
|
|
*/
|
|
extern int is_main_worktree(const struct worktree *wt);
|
|
|
|
/*
|
|
* Return the reason string if the given worktree is locked or NULL
|
|
* otherwise.
|
|
*/
|
|
extern const char *is_worktree_locked(struct worktree *wt);
|
|
|
|
/*
|
|
* Free up the memory for worktree(s)
|
|
*/
|
|
extern void free_worktrees(struct worktree **);
|
|
|
|
/*
|
|
* Check if a per-worktree symref points to a ref in the main worktree
|
|
* or any linked worktree, and return the worktree that holds the ref,
|
|
* or NULL otherwise. The result may be destroyed by the next call.
|
|
*/
|
|
extern const struct worktree *find_shared_symref(const char *symref,
|
|
const char *target);
|
|
|
|
int is_worktree_being_rebased(const struct worktree *wt, const char *target);
|
|
int is_worktree_being_bisected(const struct worktree *wt, const char *target);
|
|
|
|
/*
|
|
* Similar to git_path() but can produce paths for a specified
|
|
* worktree instead of current one
|
|
*/
|
|
extern const char *worktree_git_path(const struct worktree *wt,
|
|
const char *fmt, ...)
|
|
__attribute__((format (printf, 2, 3)));
|
|
|
|
#endif
|