rebase --root: fix amending root commit messages
[git.git] / worktree.h
blobfe38ce10c300ba456f406950bf960d19d5d79cce
1 #ifndef WORKTREE_H
2 #define WORKTREE_H
4 #include "refs.h"
6 struct strbuf;
8 struct worktree {
9 char *path;
10 char *id;
11 char *head_ref; /* NULL if HEAD is broken or detached */
12 char *lock_reason; /* internal use */
13 struct object_id head_oid;
14 int is_detached;
15 int is_bare;
16 int is_current;
17 int lock_reason_valid;
20 /* Functions for acting on the information about worktrees. */
22 #define GWT_SORT_LINKED (1 << 0) /* keeps linked worktrees sorted */
25 * Get the worktrees. The primary worktree will always be the first returned,
26 * and linked worktrees will be pointed to by 'next' in each subsequent
27 * worktree. No specific ordering is done on the linked worktrees.
29 * The caller is responsible for freeing the memory from the returned
30 * worktree(s).
32 extern struct worktree **get_worktrees(unsigned flags);
35 * Returns 1 if linked worktrees exist, 0 otherwise.
37 extern int submodule_uses_worktrees(const char *path);
40 * Return git dir of the worktree. Note that the path may be relative.
41 * If wt is NULL, git dir of current worktree is returned.
43 extern const char *get_worktree_git_dir(const struct worktree *wt);
46 * Search a worktree that can be unambiguously identified by
47 * "arg". "prefix" must not be NULL.
49 extern struct worktree *find_worktree(struct worktree **list,
50 const char *prefix,
51 const char *arg);
54 * Return true if the given worktree is the main one.
56 extern int is_main_worktree(const struct worktree *wt);
59 * Return the reason string if the given worktree is locked or NULL
60 * otherwise.
62 extern const char *is_worktree_locked(struct worktree *wt);
64 #define WT_VALIDATE_WORKTREE_MISSING_OK (1 << 0)
67 * Return zero if the worktree is in good condition. Error message is
68 * returned if "errmsg" is not NULL.
70 extern int validate_worktree(const struct worktree *wt,
71 struct strbuf *errmsg,
72 unsigned flags);
75 * Update worktrees/xxx/gitdir with the new path.
77 extern void update_worktree_location(struct worktree *wt,
78 const char *path_);
81 * Free up the memory for worktree(s)
83 extern void free_worktrees(struct worktree **);
86 * Check if a per-worktree symref points to a ref in the main worktree
87 * or any linked worktree, and return the worktree that holds the ref,
88 * or NULL otherwise. The result may be destroyed by the next call.
90 extern const struct worktree *find_shared_symref(const char *symref,
91 const char *target);
94 * Similar to head_ref() for all HEADs _except_ one from the current
95 * worktree, which is covered by head_ref().
97 int other_head_refs(each_ref_fn fn, void *cb_data);
99 int is_worktree_being_rebased(const struct worktree *wt, const char *target);
100 int is_worktree_being_bisected(const struct worktree *wt, const char *target);
103 * Similar to git_path() but can produce paths for a specified
104 * worktree instead of current one
106 extern const char *worktree_git_path(const struct worktree *wt,
107 const char *fmt, ...)
108 __attribute__((format (printf, 2, 3)));
110 #endif