2015-10-02 11:55:31 +00:00
|
|
|
#ifndef WORKTREE_H
|
|
|
|
#define WORKTREE_H
|
|
|
|
|
2018-08-15 17:54:05 +00:00
|
|
|
#include "cache.h"
|
2017-08-23 12:36:59 +00:00
|
|
|
#include "refs.h"
|
|
|
|
|
2018-01-24 09:53:51 +00:00
|
|
|
struct strbuf;
|
|
|
|
|
2015-10-08 17:01:03 +00:00
|
|
|
struct worktree {
|
|
|
|
char *path;
|
2016-04-22 13:01:26 +00:00
|
|
|
char *id;
|
2017-04-24 10:01:23 +00:00
|
|
|
char *head_ref; /* NULL if HEAD is broken or detached */
|
2018-10-30 06:24:09 +00:00
|
|
|
char *lock_reason; /* private - use worktree_lock_reason */
|
2017-10-15 22:07:08 +00:00
|
|
|
struct object_id head_oid;
|
2015-10-08 17:01:04 +00:00
|
|
|
int is_detached;
|
|
|
|
int is_bare;
|
2016-04-22 13:01:28 +00:00
|
|
|
int is_current;
|
2018-10-30 06:24:08 +00:00
|
|
|
int lock_reason_valid; /* private */
|
2015-10-08 17:01:03 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Get the worktrees. The primary worktree will always be the first returned,
|
2020-06-19 23:35:43 +00:00
|
|
|
* and linked worktrees will follow in no particular order.
|
2015-10-08 17:01:03 +00:00
|
|
|
*
|
|
|
|
* The caller is responsible for freeing the memory from the returned
|
2020-06-19 23:35:43 +00:00
|
|
|
* worktrees by calling free_worktrees().
|
2015-10-08 17:01:03 +00:00
|
|
|
*/
|
2020-06-19 23:35:44 +00:00
|
|
|
struct worktree **get_worktrees(void);
|
2015-10-08 17:01:03 +00:00
|
|
|
|
2016-12-12 19:04:33 +00:00
|
|
|
/*
|
|
|
|
* Returns 1 if linked worktrees exist, 0 otherwise.
|
|
|
|
*/
|
2019-04-29 08:28:14 +00:00
|
|
|
int submodule_uses_worktrees(const char *path);
|
2016-12-12 19:04:33 +00:00
|
|
|
|
2016-04-22 13:01:26 +00:00
|
|
|
/*
|
|
|
|
* Return git dir of the worktree. Note that the path may be relative.
|
|
|
|
* If wt is NULL, git dir of current worktree is returned.
|
|
|
|
*/
|
2019-04-29 08:28:14 +00:00
|
|
|
const char *get_worktree_git_dir(const struct worktree *wt);
|
2016-04-22 13:01:26 +00:00
|
|
|
|
2016-06-03 12:19:39 +00:00
|
|
|
/*
|
worktree: improve find_worktree() documentation
Do a better job of explaining that find_worktree()'s main purpose is to
locate a worktree based upon input from a user which may be some sort of
shorthand for identifying a worktree rather than an actual path. For
instance, one shorthand a user can use to identify a worktree is by
unique path suffix (i.e. given worktrees at paths "foo/bar" and
"foo/baz", the latter can be identified simply as "baz"). The actual
heuristics find_worktree() uses to select a worktree may be expanded in
the future (for instance, one day it may allow worktree selection by
<id> of the .git/worktrees/<id>/ administrative directory), thus the
documentation does not provide a precise description of how matching is
performed, instead leaving it open-ended to allow for future
enhancement.
While at it, drop mention of the non-NULL requirement of `prefix` since
NULL has long been allowed. For instance, prefix_filename() has
explicitly allowed NULL since 116fb64e43 (prefix_filename: drop length
parameter, 2017-03-20), and find_worktree() itself since e4da43b1f0
(prefix_filename: return newly allocated string, 2017-03-20).
Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2020-02-24 09:08:46 +00:00
|
|
|
* Search for the worktree identified unambiguously by `arg` -- typically
|
|
|
|
* supplied by the user via the command-line -- which may be a pathname or some
|
|
|
|
* shorthand uniquely identifying a worktree, thus making it convenient for the
|
|
|
|
* user to specify a worktree with minimal typing. For instance, if the last
|
|
|
|
* component (say, "foo") of a worktree's pathname is unique among worktrees
|
|
|
|
* (say, "work/foo" and "work/bar"), it can be used to identify the worktree
|
|
|
|
* unambiguously.
|
|
|
|
*
|
|
|
|
* `prefix` should be the `prefix` handed to top-level Git commands along with
|
|
|
|
* `argc` and `argv`.
|
|
|
|
*
|
|
|
|
* Return the worktree identified by `arg`, or NULL if not found.
|
2016-06-03 12:19:39 +00:00
|
|
|
*/
|
2019-04-29 08:28:14 +00:00
|
|
|
struct worktree *find_worktree(struct worktree **list,
|
2019-04-29 08:28:23 +00:00
|
|
|
const char *prefix,
|
|
|
|
const char *arg);
|
2016-06-03 12:19:39 +00:00
|
|
|
|
2020-02-24 09:08:47 +00:00
|
|
|
/*
|
|
|
|
* Return the worktree corresponding to `path`, or NULL if no such worktree
|
|
|
|
* exists.
|
|
|
|
*/
|
|
|
|
struct worktree *find_worktree_by_path(struct worktree **, const char *path);
|
|
|
|
|
2016-06-03 12:19:40 +00:00
|
|
|
/*
|
|
|
|
* Return true if the given worktree is the main one.
|
|
|
|
*/
|
2019-04-29 08:28:14 +00:00
|
|
|
int is_main_worktree(const struct worktree *wt);
|
2016-06-03 12:19:40 +00:00
|
|
|
|
2016-06-13 12:18:23 +00:00
|
|
|
/*
|
|
|
|
* Return the reason string if the given worktree is locked or NULL
|
|
|
|
* otherwise.
|
|
|
|
*/
|
2019-04-29 08:28:14 +00:00
|
|
|
const char *worktree_lock_reason(struct worktree *wt);
|
2016-06-13 12:18:23 +00:00
|
|
|
|
2018-02-12 09:49:40 +00:00
|
|
|
#define WT_VALIDATE_WORKTREE_MISSING_OK (1 << 0)
|
|
|
|
|
2018-01-24 09:53:51 +00:00
|
|
|
/*
|
|
|
|
* Return zero if the worktree is in good condition. Error message is
|
|
|
|
* returned if "errmsg" is not NULL.
|
|
|
|
*/
|
2019-04-29 08:28:14 +00:00
|
|
|
int validate_worktree(const struct worktree *wt,
|
2019-04-29 08:28:23 +00:00
|
|
|
struct strbuf *errmsg,
|
|
|
|
unsigned flags);
|
2018-01-24 09:53:51 +00:00
|
|
|
|
2018-02-12 09:49:35 +00:00
|
|
|
/*
|
|
|
|
* Update worktrees/xxx/gitdir with the new path.
|
|
|
|
*/
|
2019-04-29 08:28:14 +00:00
|
|
|
void update_worktree_location(struct worktree *wt,
|
2019-04-29 08:28:23 +00:00
|
|
|
const char *path_);
|
2018-02-12 09:49:35 +00:00
|
|
|
|
2020-08-31 06:57:57 +00:00
|
|
|
typedef void (* worktree_repair_fn)(int iserr, const char *path,
|
|
|
|
const char *msg, void *cb_data);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Visit each registered linked worktree and repair corruptions. For each
|
|
|
|
* repair made or error encountered while attempting a repair, the callback
|
|
|
|
* function, if non-NULL, is called with the path of the worktree and a
|
|
|
|
* description of the repair or error, along with the callback user-data.
|
|
|
|
*/
|
|
|
|
void repair_worktrees(worktree_repair_fn, void *cb_data);
|
|
|
|
|
2020-08-31 06:57:58 +00:00
|
|
|
/*
|
|
|
|
* Repair administrative files corresponding to the worktree at the given path.
|
|
|
|
* The worktree's .git file pointing at the repository must be intact for the
|
|
|
|
* repair to succeed. Useful for re-associating an orphaned worktree with the
|
|
|
|
* repository if the worktree has been moved manually (without using "git
|
|
|
|
* worktree move"). For each repair made or error encountered while attempting
|
|
|
|
* a repair, the callback function, if non-NULL, is called with the path of the
|
|
|
|
* worktree and a description of the repair or error, along with the callback
|
|
|
|
* user-data.
|
|
|
|
*/
|
|
|
|
void repair_worktree_at_path(const char *, worktree_repair_fn, void *cb_data);
|
|
|
|
|
2015-10-08 17:01:03 +00:00
|
|
|
/*
|
|
|
|
* Free up the memory for worktree(s)
|
|
|
|
*/
|
2019-04-29 08:28:14 +00:00
|
|
|
void free_worktrees(struct worktree **);
|
2015-10-08 17:01:03 +00:00
|
|
|
|
2015-10-02 11:55:31 +00:00
|
|
|
/*
|
|
|
|
* Check if a per-worktree symref points to a ref in the main worktree
|
2016-04-22 13:01:27 +00:00
|
|
|
* or any linked worktree, and return the worktree that holds the ref,
|
|
|
|
* or NULL otherwise. The result may be destroyed by the next call.
|
2015-10-02 11:55:31 +00:00
|
|
|
*/
|
2019-04-29 08:28:14 +00:00
|
|
|
const struct worktree *find_shared_symref(const char *symref,
|
2019-04-29 08:28:23 +00:00
|
|
|
const char *target);
|
2015-10-02 11:55:31 +00:00
|
|
|
|
2017-08-23 12:36:59 +00:00
|
|
|
/*
|
|
|
|
* Similar to head_ref() for all HEADs _except_ one from the current
|
|
|
|
* worktree, which is covered by head_ref().
|
|
|
|
*/
|
|
|
|
int other_head_refs(each_ref_fn fn, void *cb_data);
|
|
|
|
|
2016-04-22 13:01:36 +00:00
|
|
|
int is_worktree_being_rebased(const struct worktree *wt, const char *target);
|
|
|
|
int is_worktree_being_bisected(const struct worktree *wt, const char *target);
|
|
|
|
|
2016-04-22 13:01:29 +00:00
|
|
|
/*
|
|
|
|
* Similar to git_path() but can produce paths for a specified
|
|
|
|
* worktree instead of current one
|
|
|
|
*/
|
2019-04-29 08:28:20 +00:00
|
|
|
const char *worktree_git_path(const struct worktree *wt,
|
2019-04-29 08:28:23 +00:00
|
|
|
const char *fmt, ...)
|
2016-04-22 13:01:29 +00:00
|
|
|
__attribute__((format (printf, 2, 3)));
|
|
|
|
|
2018-10-21 08:08:54 +00:00
|
|
|
/*
|
|
|
|
* Parse a worktree ref (i.e. with prefix main-worktree/ or
|
|
|
|
* worktrees/) and return the position of the worktree's name and
|
|
|
|
* length (or NULL and zero if it's main worktree), and ref.
|
|
|
|
*
|
|
|
|
* All name, name_length and ref arguments could be NULL.
|
|
|
|
*/
|
|
|
|
int parse_worktree_ref(const char *worktree_ref, const char **name,
|
|
|
|
int *name_length, const char **ref);
|
2018-10-21 08:08:56 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Return a refname suitable for access from the current ref store.
|
|
|
|
*/
|
|
|
|
void strbuf_worktree_ref(const struct worktree *wt,
|
|
|
|
struct strbuf *sb,
|
|
|
|
const char *refname);
|
|
|
|
|
2015-10-02 11:55:31 +00:00
|
|
|
#endif
|