2 5d56da81 2019-01-13 stsp * Copyright (c) 2018, 2019 Stefan Sperling <stsp@openbsd.org>
4 86c3caaf 2018-03-09 stsp * Permission to use, copy, modify, and distribute this software for any
5 86c3caaf 2018-03-09 stsp * purpose with or without fee is hereby granted, provided that the above
6 86c3caaf 2018-03-09 stsp * copyright notice and this permission notice appear in all copies.
8 86c3caaf 2018-03-09 stsp * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 86c3caaf 2018-03-09 stsp * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 86c3caaf 2018-03-09 stsp * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 86c3caaf 2018-03-09 stsp * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 86c3caaf 2018-03-09 stsp * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 86c3caaf 2018-03-09 stsp * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 86c3caaf 2018-03-09 stsp * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 86c3caaf 2018-03-09 stsp struct got_worktree;
18 8656d6c4 2019-05-20 stsp struct got_commitable;
19 818c7501 2019-07-11 stsp struct got_commit_object;
20 3e3a69f1 2019-07-25 stsp struct got_fileindex;
22 eecfbcd1 2018-12-29 stsp /* status codes */
23 f8d1f275 2019-02-04 stsp #define GOT_STATUS_NO_CHANGE ' '
24 eecfbcd1 2018-12-29 stsp #define GOT_STATUS_ADD 'A'
25 eecfbcd1 2018-12-29 stsp #define GOT_STATUS_EXISTS 'E'
26 507dc3bb 2018-12-29 stsp #define GOT_STATUS_UPDATE 'U'
27 512f0d0e 2019-01-02 stsp #define GOT_STATUS_DELETE 'D'
28 276262e8 2019-02-08 stsp #define GOT_STATUS_MODIFY 'M'
29 1ebedb77 2019-10-19 stsp #define GOT_STATUS_MODE_CHANGE 'm'
30 6353ad76 2019-02-08 stsp #define GOT_STATUS_CONFLICT 'C'
31 6353ad76 2019-02-08 stsp #define GOT_STATUS_MERGE 'G'
32 f8d1f275 2019-02-04 stsp #define GOT_STATUS_MISSING '!'
33 f8d1f275 2019-02-04 stsp #define GOT_STATUS_UNVERSIONED '?'
34 0dbc2271 2019-02-05 stsp #define GOT_STATUS_OBSTRUCTED '~'
35 2a06fe5f 2019-08-24 stsp #define GOT_STATUS_NONEXISTENT 'N'
36 a129376b 2019-03-28 stsp #define GOT_STATUS_REVERT 'R'
37 2b92fad7 2019-06-02 stsp #define GOT_STATUS_CANNOT_DELETE 'd'
38 a484d721 2019-06-10 stsp #define GOT_STATUS_BUMP_BASE 'b'
39 7f47418f 2019-12-20 stsp #define GOT_STATUS_BASE_REF_ERR 'B'
40 5036ab18 2020-04-18 stsp #define GOT_STATUS_CANNOT_UPDATE '#'
42 df6221c7 2023-07-19 stsp /* Also defined in got_lib_worktree.h in case got_worktree.h is not included. */
43 df6221c7 2023-07-19 stsp #define GOT_WORKTREE_GOT_DIR ".got"
44 df6221c7 2023-07-19 stsp #define GOT_WORKTREE_CVG_DIR ".cvg"
47 0c60ce5a 2018-04-02 stsp * Attempt to initialize a new work tree on disk.
48 0c60ce5a 2018-04-02 stsp * The first argument is the path to a directory where the work tree
49 0c60ce5a 2018-04-02 stsp * will be created. The path itself must not yet exist, but the dirname(3)
50 0c60ce5a 2018-04-02 stsp * of the path must already exist.
51 93a30277 2018-12-24 stsp * The reference provided will be used to determine the new worktree's
52 93a30277 2018-12-24 stsp * base commit. The third argument speficies the work tree's path prefix.
53 df6221c7 2023-07-19 stsp * The fourth argument specifies the meta data directory to use, which
54 df6221c7 2023-07-19 stsp * should be either GOT_WORKTREE_GOT_DIR or GOT_WORKTREE_CVG_DIR.
56 86c3caaf 2018-03-09 stsp const struct got_error *got_worktree_init(const char *, struct got_reference *,
57 df6221c7 2023-07-19 stsp const char *, const char *, struct got_repository *);
60 df6221c7 2023-07-19 stsp * Attempt to open a worktree at or above the specified path, using
61 df6221c7 2023-07-19 stsp * the specified meta data directory which should be either be NULL
62 df6221c7 2023-07-19 stsp * in which case a meta directory is auto-discovered, or be one of
63 df6221c7 2023-07-19 stsp * GOT_WORKTREE_GOT_DIR and GOT_WORKTREE_CVG_DIR.
64 0c60ce5a 2018-04-02 stsp * The caller must dispose of it with got_worktree_close().
66 df6221c7 2023-07-19 stsp const struct got_error *got_worktree_open(struct got_worktree **,
67 df6221c7 2023-07-19 stsp const char *path, const char *meta_dir);
69 0c60ce5a 2018-04-02 stsp /* Dispose of an open work tree. */
70 3a6ce05a 2019-02-11 stsp const struct got_error *got_worktree_close(struct got_worktree *);
73 c7f4312f 2019-02-05 stsp * Get the path to the root directory of a worktree.
75 c7f4312f 2019-02-05 stsp const char *got_worktree_get_root_path(struct got_worktree *);
78 0c60ce5a 2018-04-02 stsp * Get the path to the repository associated with a worktree.
80 2fbdb5ae 2018-12-29 stsp const char *got_worktree_get_repo_path(struct got_worktree *);
83 49520a32 2018-12-29 stsp * Get the path prefix associated with a worktree.
85 49520a32 2018-12-29 stsp const char *got_worktree_get_path_prefix(struct got_worktree *);
88 b2118c49 2020-07-28 stsp * Get the UUID of a work tree as a string.
89 b2118c49 2020-07-28 stsp * The caller must dispose of the returned UUID string with free(3).
91 b2118c49 2020-07-28 stsp const struct got_error *got_worktree_get_uuid(char **, struct got_worktree *);
94 e5dc7198 2018-12-29 stsp * Check if a user-provided path prefix matches that of the worktree.
96 e5dc7198 2018-12-29 stsp const struct got_error *got_worktree_match_path_prefix(int *,
97 e5dc7198 2018-12-29 stsp struct got_worktree *, const char *);
100 9587e6cc 2023-01-28 mark * Prefix for references pointing at base commit of backout/cherrypick commits.
101 9587e6cc 2023-01-28 mark * Reference path takes the form: PREFIX-WORKTREE_UUID-COMMIT_ID
103 9587e6cc 2023-01-28 mark #define GOT_WORKTREE_CHERRYPICK_REF_PREFIX "refs/got/worktree/cherrypick"
104 9587e6cc 2023-01-28 mark #define GOT_WORKTREE_BACKOUT_REF_PREFIX "refs/got/worktree/backout"
106 9587e6cc 2023-01-28 mark #define GOT_WORKTREE_CHERRYPICK_REF_PREFIX_LEN \
107 9587e6cc 2023-01-28 mark sizeof(GOT_WORKTREE_CHERRYPICK_REF_PREFIX) - 1
108 9587e6cc 2023-01-28 mark #define GOT_WORKTREE_BACKOUT_REF_PREFIX_LEN \
109 9587e6cc 2023-01-28 mark sizeof(GOT_WORKTREE_BACKOUT_REF_PREFIX) - 1
110 9587e6cc 2023-01-28 mark #define GOT_WORKTREE_UUID_STRLEN 36
112 9587e6cc 2023-01-28 mark const struct got_error *got_worktree_get_logmsg_ref_name(char **,
113 9587e6cc 2023-01-28 mark struct got_worktree *, const char *);
115 0c60ce5a 2018-04-02 stsp * Get the name of a work tree's HEAD reference.
117 bc70eb79 2019-05-09 stsp const char *got_worktree_get_head_ref_name(struct got_worktree *);
120 024e9686 2019-05-14 stsp * Set the branch head reference of the work tree.
122 024e9686 2019-05-14 stsp const struct got_error *got_worktree_set_head_ref(struct got_worktree *,
123 024e9686 2019-05-14 stsp struct got_reference *);
126 507dc3bb 2018-12-29 stsp * Get the current base commit ID of a worktree.
128 b72f483a 2019-02-05 stsp struct got_object_id *got_worktree_get_base_commit_id(struct got_worktree *);
131 507dc3bb 2018-12-29 stsp * Set the base commit Id of a worktree.
133 507dc3bb 2018-12-29 stsp const struct got_error *got_worktree_set_base_commit_id(struct got_worktree *,
134 507dc3bb 2018-12-29 stsp struct got_repository *, struct got_object_id *);
137 c935fd51 2023-07-23 mark * Get the state of the work tree. If the work tree's global base commit is
138 c935fd51 2023-07-23 mark * the tip of the work tree's current branch, and each file in the index is
139 c935fd51 2023-07-23 mark * based on this same commit, the char out parameter will be
140 c935fd51 2023-07-23 mark * GOT_WORKTREE_UPTODATE, else it will be GOT_WORKTREE_OUTOFDATE.
142 c935fd51 2023-07-23 mark const struct got_error *got_worktree_get_state(char *,
143 c935fd51 2023-07-23 mark struct got_repository *, struct got_worktree *);
145 c935fd51 2023-07-23 mark #define GOT_WORKTREE_UPTODATE '*'
146 c935fd51 2023-07-23 mark #define GOT_WORKTREE_OUTOFDATE '~'
149 50b0790e 2020-09-11 stsp * Obtain a parsed representation of this worktree's got.conf file.
150 50b0790e 2020-09-11 stsp * Return NULL if this configuration file could not be read.
152 50b0790e 2020-09-11 stsp const struct got_gotconfig *got_worktree_get_gotconfig(struct got_worktree *);
154 0c60ce5a 2018-04-02 stsp /* A callback function which is invoked when a path is checked out. */
155 1ee397ad 2019-07-12 stsp typedef const struct got_error *(*got_worktree_checkout_cb)(void *,
156 1ee397ad 2019-07-12 stsp unsigned char, const char *);
158 f2a9dc41 2019-12-13 tracey /* A callback function which is invoked when a path is removed. */
159 f2a9dc41 2019-12-13 tracey typedef const struct got_error *(*got_worktree_delete_cb)(void *,
160 f2a9dc41 2019-12-13 tracey unsigned char, unsigned char, const char *);
163 0c60ce5a 2018-04-02 stsp * Attempt to check out files into a work tree from its associated repository
164 0c60ce5a 2018-04-02 stsp * and path prefix, and update the work tree's file index accordingly.
165 0c60ce5a 2018-04-02 stsp * File content is obtained from blobs within the work tree's path prefix
166 93a30277 2018-12-24 stsp * inside the tree corresponding to the work tree's base commit.
167 0c60ce5a 2018-04-02 stsp * The checkout progress callback will be invoked with the provided
168 0c60ce5a 2018-04-02 stsp * void * argument, and the path of each checked out file.
170 f2ea84fa 2019-07-27 stsp * It is possible to restrict the checkout operation to specific paths in
171 f2ea84fa 2019-07-27 stsp * the work tree, in which case all files outside those paths will remain at
172 c4cdcb68 2019-04-03 stsp * their currently recorded base commit. Inconsistent base commits can be
173 c4cdcb68 2019-04-03 stsp * repaired later by running another update operation across the entire work
174 c4cdcb68 2019-04-03 stsp * tree. Inconsistent base-commits may also occur if this function runs into
175 c4cdcb68 2019-04-03 stsp * an error or if the checkout operation is cancelled by the cancel callback.
176 f2ea84fa 2019-07-27 stsp * Allspecified paths are relative to the work tree's root. Pass a pathlist
177 f2ea84fa 2019-07-27 stsp * with a single empty path "" to check out files across the entire work tree.
179 c4cdcb68 2019-04-03 stsp * Some operations may refuse to run while the work tree contains files from
180 c4cdcb68 2019-04-03 stsp * multiple base commits.
182 86c3caaf 2018-03-09 stsp const struct got_error *got_worktree_checkout_files(struct got_worktree *,
183 f2ea84fa 2019-07-27 stsp struct got_pathlist_head *, struct got_repository *,
184 e6209546 2019-08-22 stsp got_worktree_checkout_cb, void *, got_cancel_cb, void *);
186 234035bc 2019-06-01 stsp /* Merge the differences between two commits into a work tree. */
187 234035bc 2019-06-01 stsp const struct got_error *
188 234035bc 2019-06-01 stsp got_worktree_merge_files(struct got_worktree *,
189 234035bc 2019-06-01 stsp struct got_object_id *, struct got_object_id *,
190 234035bc 2019-06-01 stsp struct got_repository *, got_worktree_checkout_cb, void *,
191 e6209546 2019-08-22 stsp got_cancel_cb, void *);
194 12463d8b 2019-12-13 stsp * A callback function which is invoked to report a file's status.
196 12463d8b 2019-12-13 stsp * If a valid directory file descriptor and a directory entry name are passed,
197 12463d8b 2019-12-13 stsp * these should be used to open the file instead of opening the file by path.
198 12463d8b 2019-12-13 stsp * This prevents race conditions if the filesystem is modified concurrently.
199 12463d8b 2019-12-13 stsp * If the directory descriptor is not available then its value will be -1.
201 b72f483a 2019-02-05 stsp typedef const struct got_error *(*got_worktree_status_cb)(void *,
202 88d0e355 2019-08-03 stsp unsigned char, unsigned char, const char *, struct got_object_id *,
203 12463d8b 2019-12-13 stsp struct got_object_id *, struct got_object_id *, int, const char *);
206 f8d1f275 2019-02-04 stsp * Report the status of paths in the work tree.
207 f8d1f275 2019-02-04 stsp * The status callback will be invoked with the provided void * argument,
208 f8d1f275 2019-02-04 stsp * a path, and a corresponding status code.
210 6c34b1aa 2019-03-18 stsp const struct got_error *got_worktree_status(struct got_worktree *,
211 f6343036 2021-06-22 stsp struct got_pathlist_head *, struct got_repository *, int no_ignores,
212 e6209546 2019-08-22 stsp got_worktree_status_cb, void *, got_cancel_cb cancel_cb, void *);
215 6c7ab921 2019-03-18 stsp * Try to resolve a user-provided path to an on-disk path in the work tree.
216 6c7ab921 2019-03-18 stsp * The caller must dispose of the resolved path with free(3).
218 6c7ab921 2019-03-18 stsp const struct got_error *got_worktree_resolve_path(char **,
219 6c7ab921 2019-03-18 stsp struct got_worktree *, const char *);
221 1dd54920 2019-05-11 stsp /* Schedule files at on-disk paths for addition in the next commit. */
222 031a5338 2019-03-26 stsp const struct got_error *got_worktree_schedule_add(struct got_worktree *,
223 4e68cba3 2019-11-23 stsp struct got_pathlist_head *, got_worktree_checkout_cb, void *,
224 022fae89 2019-12-06 tracey struct got_repository *, int);
227 17ed4618 2019-06-02 stsp * Remove files from disk and schedule them to be deleted in the next commit.
228 2ec1f75b 2019-03-26 stsp * Don't allow deleting files with uncommitted modifications, unless the
229 2ec1f75b 2019-03-26 stsp * parameter 'delete_local_mods' is set.
231 2ec1f75b 2019-03-26 stsp const struct got_error *
232 17ed4618 2019-06-02 stsp got_worktree_schedule_delete(struct got_worktree *,
233 766841c2 2020-08-13 stsp struct got_pathlist_head *, int, const char *,
234 4e12cd97 2022-01-25 stsp got_worktree_delete_cb, void *, struct got_repository *, int, int);
236 33aa809d 2019-08-08 stsp /* A callback function which is used to select or reject a patch. */
237 33aa809d 2019-08-08 stsp typedef const struct got_error *(*got_worktree_patch_cb)(int *, void *,
238 33aa809d 2019-08-08 stsp unsigned char, const char *, FILE *, int, int);
240 33aa809d 2019-08-08 stsp /* Values for result output parameter of got_wortree_patch_cb. */
241 33aa809d 2019-08-08 stsp #define GOT_PATCH_CHOICE_NONE 0
242 33aa809d 2019-08-08 stsp #define GOT_PATCH_CHOICE_YES 1
243 33aa809d 2019-08-08 stsp #define GOT_PATCH_CHOICE_NO 2
244 33aa809d 2019-08-08 stsp #define GOT_PATCH_CHOICE_QUIT 3
247 a129376b 2019-03-28 stsp * Revert a file at the specified path such that it matches its
248 a129376b 2019-03-28 stsp * original state in the worktree's base commit.
249 33aa809d 2019-08-08 stsp * If the patch callback is not NULL, call it to select patch hunks to
250 33aa809d 2019-08-08 stsp * revert. Otherwise, revert the whole file found at each path.
252 a129376b 2019-03-28 stsp const struct got_error *got_worktree_revert(struct got_worktree *,
253 e20a8b6f 2019-06-04 stsp struct got_pathlist_head *, got_worktree_checkout_cb, void *,
254 33aa809d 2019-08-08 stsp got_worktree_patch_cb patch_cb, void *patch_arg,
255 e20a8b6f 2019-06-04 stsp struct got_repository *);
258 33ad4cbe 2019-05-12 jcs * A callback function which is invoked when a commit message is requested.
259 8656d6c4 2019-05-20 stsp * Passes a pathlist with a struct got_commitable * in the data pointer of
260 2a47b1e5 2022-11-01 stsp * each element, the path to a file which contains a diff of changes to be
261 2a47b1e5 2022-11-01 stsp * committed (may be NULL), and a pointer to the log message that must be
262 2a47b1e5 2022-11-01 stsp * set by the callback and will be freed after committing, and an argument
263 2a47b1e5 2022-11-01 stsp * passed through to the callback.
265 33ad4cbe 2019-05-12 jcs typedef const struct got_error *(*got_worktree_commit_msg_cb)(
266 2a47b1e5 2022-11-01 stsp struct got_pathlist_head *, const char *, char **, void *);
269 c4296144 2019-05-09 stsp * Create a new commit from changes in the work tree.
270 c4296144 2019-05-09 stsp * Return the ID of the newly created commit.
271 c4296144 2019-05-09 stsp * The worktree's base commit will be set to this new commit.
272 c4296144 2019-05-09 stsp * Files unaffected by this commit operation will retain their
273 c4296144 2019-05-09 stsp * current base commit.
274 de18fc63 2019-05-09 stsp * An author and a non-empty log message must be specified.
275 de18fc63 2019-05-09 stsp * The name of the committer is optional (may be NULL).
276 35213c7c 2020-07-23 stsp * If a path to be committed contains a symlink which points outside
277 35213c7c 2020-07-23 stsp * of the path space under version control, raise an error unless
278 35213c7c 2020-07-23 stsp * committing of such paths is being forced by the caller.
280 de18fc63 2019-05-09 stsp const struct got_error *got_worktree_commit(struct got_object_id **,
281 5c1e53bc 2019-07-28 stsp struct got_worktree *, struct got_pathlist_head *, const char *,
282 12383673 2023-02-18 mark const char *, int, int, int, got_worktree_commit_msg_cb, void *,
283 33ad4cbe 2019-05-12 jcs got_worktree_status_cb, void *, struct got_repository *);
285 8656d6c4 2019-05-20 stsp /* Get the path of a commitable worktree item. */
286 8656d6c4 2019-05-20 stsp const char *got_commitable_get_path(struct got_commitable *);
288 8656d6c4 2019-05-20 stsp /* Get the status of a commitable worktree item. */
289 8656d6c4 2019-05-20 stsp unsigned int got_commitable_get_status(struct got_commitable *);
292 818c7501 2019-07-11 stsp * Prepare for rebasing a branch onto the work tree's current branch.
293 818c7501 2019-07-11 stsp * This function creates references to a temporary branch, the branch
294 818c7501 2019-07-11 stsp * being rebased, and the work tree's current branch, under the
295 818c7501 2019-07-11 stsp * "got/worktree/rebase/" namespace. These references are used to
296 818c7501 2019-07-11 stsp * keep track of rebase operation state and are used as input and/or
297 818c7501 2019-07-11 stsp * output arguments with other rebase-related functions.
298 3e3a69f1 2019-07-25 stsp * The function also returns a pointer to a fileindex which must be
299 3e3a69f1 2019-07-25 stsp * passed back to other rebase-related functions.
301 818c7501 2019-07-11 stsp const struct got_error *got_worktree_rebase_prepare(struct got_reference **,
302 3e3a69f1 2019-07-25 stsp struct got_reference **, struct got_fileindex **, struct got_worktree *,
303 3e3a69f1 2019-07-25 stsp struct got_reference *, struct got_repository *);
306 818c7501 2019-07-11 stsp * Continue an interrupted rebase operation.
307 818c7501 2019-07-11 stsp * This function returns existing references created when rebase was prepared,
308 818c7501 2019-07-11 stsp * and the ID of the commit currently being rebased. This should be called
309 818c7501 2019-07-11 stsp * before either resuming or aborting a rebase operation.
310 3e3a69f1 2019-07-25 stsp * The function also returns a pointer to a fileindex which must be
311 3e3a69f1 2019-07-25 stsp * passed back to other rebase-related functions.
313 818c7501 2019-07-11 stsp const struct got_error *got_worktree_rebase_continue(struct got_object_id **,
314 818c7501 2019-07-11 stsp struct got_reference **, struct got_reference **, struct got_reference **,
315 3e3a69f1 2019-07-25 stsp struct got_fileindex **, struct got_worktree *, struct got_repository *);
317 818c7501 2019-07-11 stsp /* Check whether a, potentially interrupted, rebase operation is in progress. */
318 818c7501 2019-07-11 stsp const struct got_error *got_worktree_rebase_in_progress(int *,
319 818c7501 2019-07-11 stsp struct got_worktree *);
322 818c7501 2019-07-11 stsp * Merge changes from the commit currently being rebased into the work tree.
323 818c7501 2019-07-11 stsp * Report affected files, including merge conflicts, via the specified
324 01757395 2019-07-12 stsp * progress callback. Also populate a list of affected paths which should
325 01757395 2019-07-12 stsp * be passed to got_worktree_rebase_commit() after a conflict-free merge.
326 01757395 2019-07-12 stsp * This list must be initialized with TAILQ_INIT() and disposed of with
327 d8bacb93 2023-01-10 mark * got_pathlist_free(list, GOT_PATHLIST_FREE_PATH).
329 818c7501 2019-07-11 stsp const struct got_error *got_worktree_rebase_merge_files(
330 3e3a69f1 2019-07-25 stsp struct got_pathlist_head *, struct got_worktree *, struct got_fileindex *,
331 01757395 2019-07-12 stsp struct got_object_id *, struct got_object_id *, struct got_repository *,
332 e6209546 2019-08-22 stsp got_worktree_checkout_cb, void *, got_cancel_cb, void *);
335 01757395 2019-07-12 stsp * Commit changes merged by got_worktree_rebase_merge_files() to a temporary
336 01757395 2019-07-12 stsp * branch and return the ID of the newly created commit. An optional list of
337 01757395 2019-07-12 stsp * merged paths can be provided; otherwise this function will perform a status
338 01757395 2019-07-12 stsp * crawl across the entire work tree to find paths to commit.
340 818c7501 2019-07-11 stsp const struct got_error *got_worktree_rebase_commit(struct got_object_id **,
341 3e3a69f1 2019-07-25 stsp struct got_pathlist_head *, struct got_worktree *, struct got_fileindex *,
342 598eac43 2022-07-22 stsp struct got_reference *, const char *, struct got_commit_object *,
343 12383673 2023-02-18 mark struct got_object_id *, int, struct got_repository *);
345 818c7501 2019-07-11 stsp /* Postpone the rebase operation. Should be called after a merge conflict. */
346 3e3a69f1 2019-07-25 stsp const struct got_error *got_worktree_rebase_postpone(struct got_worktree *,
347 3e3a69f1 2019-07-25 stsp struct got_fileindex *);
350 818c7501 2019-07-11 stsp * Complete the current rebase operation. This should be called once all
351 818c7501 2019-07-11 stsp * commits have been rebased successfully.
352 e600f124 2021-03-21 stsp * The create_backup parameter controls whether the rebased branch will
353 e600f124 2021-03-21 stsp * be backed up via a reference in refs/got/backup/rebase/.
355 818c7501 2019-07-11 stsp const struct got_error *got_worktree_rebase_complete(struct got_worktree *,
356 3e3a69f1 2019-07-25 stsp struct got_fileindex *, struct got_reference *, struct got_reference *,
357 ef85a376 2023-02-01 mark struct got_repository *, int create_backup);
360 818c7501 2019-07-11 stsp * Abort the current rebase operation.
361 818c7501 2019-07-11 stsp * Report reverted files via the specified progress callback.
363 818c7501 2019-07-11 stsp const struct got_error *got_worktree_rebase_abort(struct got_worktree *,
364 3e3a69f1 2019-07-25 stsp struct got_fileindex *, struct got_repository *, struct got_reference *,
365 0ebf8283 2019-07-24 stsp got_worktree_checkout_cb, void *);
368 0ebf8283 2019-07-24 stsp * Prepare for editing the history of the work tree's current branch.
369 0ebf8283 2019-07-24 stsp * This function creates references to a temporary branch, and the
370 0ebf8283 2019-07-24 stsp * work tree's current branch, under the "got/worktree/histedit/" namespace.
371 0ebf8283 2019-07-24 stsp * These references are used to keep track of histedit operation state and
372 0ebf8283 2019-07-24 stsp * are used as input and/or output arguments with other histedit-related
373 0ebf8283 2019-07-24 stsp * functions.
375 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_prepare(struct got_reference **,
376 3e3a69f1 2019-07-25 stsp struct got_reference **, struct got_object_id **, struct got_fileindex **,
377 3e3a69f1 2019-07-25 stsp struct got_worktree *, struct got_repository *);
380 0ebf8283 2019-07-24 stsp * Continue an interrupted histedit operation.
381 0ebf8283 2019-07-24 stsp * This function returns existing references created when histedit was
382 0ebf8283 2019-07-24 stsp * prepared and the ID of the commit currently being edited.
383 0ebf8283 2019-07-24 stsp * It should be called before resuming or aborting a histedit operation.
385 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_continue(struct got_object_id **,
386 0ebf8283 2019-07-24 stsp struct got_reference **, struct got_reference **, struct got_object_id **,
387 3e3a69f1 2019-07-25 stsp struct got_fileindex **, struct got_worktree *, struct got_repository *);
389 0ebf8283 2019-07-24 stsp /* Check whether a histedit operation is in progress. */
390 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_in_progress(int *,
391 0ebf8283 2019-07-24 stsp struct got_worktree *);
394 0ebf8283 2019-07-24 stsp * Merge changes from the commit currently being edited into the work tree.
395 0ebf8283 2019-07-24 stsp * Report affected files, including merge conflicts, via the specified
396 0ebf8283 2019-07-24 stsp * progress callback. Also populate a list of affected paths which should
397 0ebf8283 2019-07-24 stsp * be passed to got_worktree_histedit_commit() after a conflict-free merge.
398 0ebf8283 2019-07-24 stsp * This list must be initialized with TAILQ_INIT() and disposed of with
399 d8bacb93 2023-01-10 mark * got_pathlist_free(list, GOT_PATHLIST_FREE_PATH).
401 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_merge_files(
402 3e3a69f1 2019-07-25 stsp struct got_pathlist_head *, struct got_worktree *, struct got_fileindex *,
403 0ebf8283 2019-07-24 stsp struct got_object_id *, struct got_object_id *, struct got_repository *,
404 e6209546 2019-08-22 stsp got_worktree_checkout_cb, void *, got_cancel_cb, void *);
407 0ebf8283 2019-07-24 stsp * Commit changes merged by got_worktree_histedit_merge_files() to a temporary
408 0ebf8283 2019-07-24 stsp * branch and return the ID of the newly created commit. An optional list of
409 0ebf8283 2019-07-24 stsp * merged paths can be provided; otherwise this function will perform a status
410 0ebf8283 2019-07-24 stsp * crawl across the entire work tree to find paths to commit.
411 0ebf8283 2019-07-24 stsp * An optional log message can be provided which will be used instead of the
412 0ebf8283 2019-07-24 stsp * commit's original message.
414 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_commit(struct got_object_id **,
415 3e3a69f1 2019-07-25 stsp struct got_pathlist_head *, struct got_worktree *, struct got_fileindex *,
416 598eac43 2022-07-22 stsp struct got_reference *, const char *, struct got_commit_object *,
417 12383673 2023-02-18 mark struct got_object_id *, const char *, int, struct got_repository *);
420 0ebf8283 2019-07-24 stsp * Record the specified commit as skipped during histedit.
421 0ebf8283 2019-07-24 stsp * This should be called for commits which get dropped or get folded into
422 0ebf8283 2019-07-24 stsp * a subsequent commit.
424 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_skip_commit(struct got_worktree *,
425 0ebf8283 2019-07-24 stsp struct got_object_id *, struct got_repository *);
427 0ebf8283 2019-07-24 stsp /* Postpone the histedit operation. */
428 3e3a69f1 2019-07-25 stsp const struct got_error *got_worktree_histedit_postpone(struct got_worktree *,
429 3e3a69f1 2019-07-25 stsp struct got_fileindex *);
432 0ebf8283 2019-07-24 stsp * Complete the current histedit operation. This should be called once all
433 0ebf8283 2019-07-24 stsp * commits have been edited successfully.
435 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_complete(struct got_worktree *,
436 3e3a69f1 2019-07-25 stsp struct got_fileindex *, struct got_reference *, struct got_reference *,
437 3e3a69f1 2019-07-25 stsp struct got_repository *);
440 0ebf8283 2019-07-24 stsp * Abort the current histedit operation.
441 0ebf8283 2019-07-24 stsp * Report reverted files via the specified progress callback.
443 0ebf8283 2019-07-24 stsp const struct got_error *got_worktree_histedit_abort(struct got_worktree *,
444 3e3a69f1 2019-07-25 stsp struct got_fileindex *, struct got_repository *, struct got_reference *,
445 3e3a69f1 2019-07-25 stsp struct got_object_id *, got_worktree_checkout_cb, void *);
447 c3022ba5 2019-07-27 stsp /* Get the path to this work tree's histedit script file. */
448 c3022ba5 2019-07-27 stsp const struct got_error *got_worktree_get_histedit_script_path(char **,
449 0ebf8283 2019-07-24 stsp struct got_worktree *);
452 2822a352 2019-10-15 stsp * Prepare a work tree for integrating a branch.
453 2822a352 2019-10-15 stsp * Return pointers to a fileindex and locked references which must be
454 2822a352 2019-10-15 stsp * passed back to other integrate-related functions.
456 2822a352 2019-10-15 stsp const struct got_error *
457 2822a352 2019-10-15 stsp got_worktree_integrate_prepare(struct got_fileindex **,
458 abc59930 2021-09-05 naddy struct got_reference **, struct got_reference **,
459 2822a352 2019-10-15 stsp struct got_worktree *, const char *, struct got_repository *);
462 2822a352 2019-10-15 stsp * Carry out a prepared branch integration operation.
463 2822a352 2019-10-15 stsp * Report affected files via the specified progress callback.
465 2822a352 2019-10-15 stsp const struct got_error *got_worktree_integrate_continue(
466 2822a352 2019-10-15 stsp struct got_worktree *, struct got_fileindex *, struct got_repository *,
467 2822a352 2019-10-15 stsp struct got_reference *, struct got_reference *,
468 2822a352 2019-10-15 stsp got_worktree_checkout_cb, void *, got_cancel_cb, void *);
470 2822a352 2019-10-15 stsp /* Abort a prepared branch integration operation. */
471 2822a352 2019-10-15 stsp const struct got_error *got_worktree_integrate_abort(struct got_worktree *,
472 2822a352 2019-10-15 stsp struct got_fileindex *, struct got_repository *,
473 2822a352 2019-10-15 stsp struct got_reference *, struct got_reference *);
475 f259c4c1 2021-09-24 stsp /* Postpone the merge operation. Should be called after a merge conflict. */
476 f259c4c1 2021-09-24 stsp const struct got_error *got_worktree_merge_postpone(struct got_worktree *,
477 f259c4c1 2021-09-24 stsp struct got_fileindex *);
479 f259c4c1 2021-09-24 stsp /* Merge changes from the merge source branch into the worktree. */
480 f259c4c1 2021-09-24 stsp const struct got_error *
481 f259c4c1 2021-09-24 stsp got_worktree_merge_branch(struct got_worktree *worktree,
482 f259c4c1 2021-09-24 stsp struct got_fileindex *fileindex,
483 f259c4c1 2021-09-24 stsp struct got_object_id *yca_commit_id,
484 f259c4c1 2021-09-24 stsp struct got_object_id *branch_tip,
485 f259c4c1 2021-09-24 stsp struct got_repository *repo, got_worktree_checkout_cb progress_cb,
486 f259c4c1 2021-09-24 stsp void *progress_arg, got_cancel_cb cancel_cb, void *cancel_arg);
488 f259c4c1 2021-09-24 stsp /* Attempt to commit merged changes. */
489 f259c4c1 2021-09-24 stsp const struct got_error *
490 f259c4c1 2021-09-24 stsp got_worktree_merge_commit(struct got_object_id **new_commit_id,
491 f259c4c1 2021-09-24 stsp struct got_worktree *worktree, struct got_fileindex *fileindex,
492 f259c4c1 2021-09-24 stsp const char *author, const char *committer, int allow_bad_symlinks,
493 f259c4c1 2021-09-24 stsp struct got_object_id *branch_tip, const char *branch_name,
494 12383673 2023-02-18 mark int allow_conflict, struct got_repository *repo,
495 0ff8d236 2021-09-28 stsp got_worktree_status_cb status_cb, void *status_arg);
498 f259c4c1 2021-09-24 stsp * Complete the merge operation.
499 f259c4c1 2021-09-24 stsp * This should be called once changes have been successfully committed.
501 f259c4c1 2021-09-24 stsp const struct got_error *got_worktree_merge_complete(
502 f259c4c1 2021-09-24 stsp struct got_worktree *worktree, struct got_fileindex *fileindex,
503 f259c4c1 2021-09-24 stsp struct got_repository *repo);
505 f259c4c1 2021-09-24 stsp /* Check whether a merge operation is in progress. */
506 f259c4c1 2021-09-24 stsp const struct got_error *got_worktree_merge_in_progress(int *,
507 f259c4c1 2021-09-24 stsp struct got_worktree *, struct got_repository *);
510 179f9db0 2023-06-20 falsifian * Prepare for merging a branch into the work tree's current branch: lock the
511 179f9db0 2023-06-20 falsifian * worktree and check that preconditions are satisfied. The function also
512 179f9db0 2023-06-20 falsifian * returns a pointer to a fileindex which must be passed back to other
513 179f9db0 2023-06-20 falsifian * merge-related functions.
515 179f9db0 2023-06-20 falsifian const struct got_error *got_worktree_merge_prepare(struct got_fileindex **,
516 179f9db0 2023-06-20 falsifian struct got_worktree *, struct got_repository *);
519 f259c4c1 2021-09-24 stsp * This function creates a reference to the branch being merged, and to
520 f259c4c1 2021-09-24 stsp * this branch's current tip commit, in the "got/worktree/merge/" namespace.
521 f259c4c1 2021-09-24 stsp * These references are used to keep track of merge operation state and are
522 f259c4c1 2021-09-24 stsp * used as input and/or output arguments with other merge-related functions.
524 179f9db0 2023-06-20 falsifian const struct got_error *got_worktree_merge_write_refs(struct got_worktree *,
525 179f9db0 2023-06-20 falsifian struct got_reference *, struct got_repository *);
528 f259c4c1 2021-09-24 stsp * Continue an interrupted merge operation.
529 f259c4c1 2021-09-24 stsp * This function returns name of the branch being merged, and the ID of the
530 f259c4c1 2021-09-24 stsp * tip commit being merged.
531 f259c4c1 2021-09-24 stsp * This function should be called before either resuming or aborting a
532 f259c4c1 2021-09-24 stsp * merge operation.
533 f259c4c1 2021-09-24 stsp * The function also returns a pointer to a fileindex which must be
534 f259c4c1 2021-09-24 stsp * passed back to other merge-related functions.
536 f259c4c1 2021-09-24 stsp const struct got_error *got_worktree_merge_continue(char **,
537 f259c4c1 2021-09-24 stsp struct got_object_id **, struct got_fileindex **,
538 f259c4c1 2021-09-24 stsp struct got_worktree *, struct got_repository *);
541 f259c4c1 2021-09-24 stsp * Abort the current rebase operation.
542 f259c4c1 2021-09-24 stsp * Report reverted files via the specified progress callback.
544 f259c4c1 2021-09-24 stsp const struct got_error *got_worktree_merge_abort(struct got_worktree *,
545 f259c4c1 2021-09-24 stsp struct got_fileindex *, struct got_repository *,
546 f259c4c1 2021-09-24 stsp got_worktree_checkout_cb, void *);
549 fdfa9bf2 2019-08-03 stsp * Stage the specified paths for commit.
550 dc424a06 2019-08-07 stsp * If the patch callback is not NULL, call it to select patch hunks for
551 dc424a06 2019-08-07 stsp * staging. Otherwise, stage the full file content found at each path.
552 35213c7c 2020-07-23 stsp * If a path being staged contains a symlink which points outside
553 35213c7c 2020-07-23 stsp * of the path space under version control, raise an error unless
554 35213c7c 2020-07-23 stsp * staging of such paths is being forced by the caller.
556 1e71573e 2019-08-03 stsp const struct got_error *got_worktree_stage(struct got_worktree *,
557 1e71573e 2019-08-03 stsp struct got_pathlist_head *, got_worktree_status_cb, void *,
558 35213c7c 2020-07-23 stsp got_worktree_patch_cb, void *, int, struct got_repository *);
561 ad493afc 2019-08-03 stsp * Merge staged changes for the specified paths back into the work tree
562 ad493afc 2019-08-03 stsp * and mark the paths as non-staged again.
564 ad493afc 2019-08-03 stsp const struct got_error *got_worktree_unstage(struct got_worktree *,
565 ad493afc 2019-08-03 stsp struct got_pathlist_head *, got_worktree_checkout_cb, void *,
566 2e1f37b0 2019-08-08 stsp got_worktree_patch_cb, void *, struct got_repository *);
568 b2118c49 2020-07-28 stsp /* A callback function which is invoked with per-path info. */
569 b2118c49 2020-07-28 stsp typedef const struct got_error *(*got_worktree_path_info_cb)(void *,
570 b2118c49 2020-07-28 stsp const char *path, mode_t mode, time_t mtime,
571 b2118c49 2020-07-28 stsp struct got_object_id *blob_id, struct got_object_id *staged_blob_id,
572 b2118c49 2020-07-28 stsp struct got_object_id *commit_id);
575 b2118c49 2020-07-28 stsp * Report work-tree meta data for paths in the work tree.
576 b2118c49 2020-07-28 stsp * The info callback will be invoked with the provided void * argument,
577 b2118c49 2020-07-28 stsp * a path, and meta-data arguments (see got_worktree_path_info_cb).
579 b2118c49 2020-07-28 stsp const struct got_error *
580 b2118c49 2020-07-28 stsp got_worktree_path_info(struct got_worktree *, struct got_pathlist_head *,
581 b2118c49 2020-07-28 stsp got_worktree_path_info_cb, void *, got_cancel_cb , void *);
583 e600f124 2021-03-21 stsp /* References pointing at pre-rebase commit backups. */
584 e600f124 2021-03-21 stsp #define GOT_WORKTREE_REBASE_BACKUP_REF_PREFIX "refs/got/backup/rebase"
586 e600f124 2021-03-21 stsp /* References pointing at pre-histedit commit backups. */
587 e600f124 2021-03-21 stsp #define GOT_WORKTREE_HISTEDIT_BACKUP_REF_PREFIX "refs/got/backup/histedit"
590 78f5ac24 2022-03-19 op * Prepare for applying a patch.
592 78f5ac24 2022-03-19 op const struct got_error *
593 f2dd7807 2022-05-17 op got_worktree_patch_prepare(struct got_fileindex **, char **,
594 f2dd7807 2022-05-17 op struct got_worktree *);
597 78f5ac24 2022-03-19 op * Lookup paths for the "old" and "new" file before patching and check their
600 78f5ac24 2022-03-19 op const struct got_error *
601 78f5ac24 2022-03-19 op got_worktree_patch_check_path(const char *, const char *, char **, char **,
602 78f5ac24 2022-03-19 op struct got_worktree *, struct got_repository *, struct got_fileindex *);
604 f2dd7807 2022-05-17 op const struct got_error *
605 f2dd7807 2022-05-17 op got_worktree_patch_schedule_add(const char *, struct got_repository *,
606 f2dd7807 2022-05-17 op struct got_worktree *, struct got_fileindex *, got_worktree_checkout_cb,
609 f2dd7807 2022-05-17 op const struct got_error *
610 f2dd7807 2022-05-17 op got_worktree_patch_schedule_rm(const char *, struct got_repository *,
611 f2dd7807 2022-05-17 op struct got_worktree *, struct got_fileindex *, got_worktree_delete_cb,
614 78f5ac24 2022-03-19 op /* Complete the patch operation. */
615 78f5ac24 2022-03-19 op const struct got_error *
616 4bcdc895 2022-05-17 op got_worktree_patch_complete(struct got_fileindex *, const char *);
