12 char *head_ref
; /* NULL if HEAD is broken or detached */
13 char *lock_reason
; /* internal use */
14 struct object_id head_oid
;
18 int lock_reason_valid
;
21 /* Functions for acting on the information about worktrees. */
23 #define GWT_SORT_LINKED (1 << 0) /* keeps linked worktrees sorted */
26 * Get the worktrees. The primary worktree will always be the first returned,
27 * and linked worktrees will be pointed to by 'next' in each subsequent
28 * worktree. No specific ordering is done on the linked worktrees.
30 * The caller is responsible for freeing the memory from the returned
33 extern struct worktree
**get_worktrees(unsigned flags
);
36 * Returns 1 if linked worktrees exist, 0 otherwise.
38 extern int submodule_uses_worktrees(const char *path
);
41 * Return git dir of the worktree. Note that the path may be relative.
42 * If wt is NULL, git dir of current worktree is returned.
44 extern const char *get_worktree_git_dir(const struct worktree
*wt
);
47 * Search a worktree that can be unambiguously identified by
48 * "arg". "prefix" must not be NULL.
50 extern struct worktree
*find_worktree(struct worktree
**list
,
55 * Return true if the given worktree is the main one.
57 extern int is_main_worktree(const struct worktree
*wt
);
60 * Return the reason string if the given worktree is locked or NULL
63 extern const char *is_worktree_locked(struct worktree
*wt
);
65 #define WT_VALIDATE_WORKTREE_MISSING_OK (1 << 0)
68 * Return zero if the worktree is in good condition. Error message is
69 * returned if "errmsg" is not NULL.
71 extern int validate_worktree(const struct worktree
*wt
,
72 struct strbuf
*errmsg
,
76 * Update worktrees/xxx/gitdir with the new path.
78 extern void update_worktree_location(struct worktree
*wt
,
82 * Free up the memory for worktree(s)
84 extern void free_worktrees(struct worktree
**);
87 * Check if a per-worktree symref points to a ref in the main worktree
88 * or any linked worktree, and return the worktree that holds the ref,
89 * or NULL otherwise. The result may be destroyed by the next call.
91 extern const struct worktree
*find_shared_symref(const char *symref
,
95 * Similar to head_ref() for all HEADs _except_ one from the current
96 * worktree, which is covered by head_ref().
98 int other_head_refs(each_ref_fn fn
, void *cb_data
);
100 int is_worktree_being_rebased(const struct worktree
*wt
, const char *target
);
101 int is_worktree_being_bisected(const struct worktree
*wt
, const char *target
);
104 * Similar to git_path() but can produce paths for a specified
105 * worktree instead of current one
107 extern const char *worktree_git_path(const struct worktree
*wt
,
108 const char *fmt
, ...)
109 __attribute__((format (printf
, 2, 3)));