summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorEdward Thomson <ethomson@edwardthomson.com>2023-05-16 12:41:41 +0100
committerEdward Thomson <ethomson@edwardthomson.com>2023-05-16 12:41:41 +0100
commitf041a94e2c358e84adb5a0fe108288fcb3802970 (patch)
treeb01428dbfdd3e41123aa8cbee3da857affd839e5 /include
parent9d41a3fd694d983ade53fb602a58f6df25ce0656 (diff)
parent12b54ae00948a7a8422af53a8e98a5aa4d51f1f7 (diff)
downloadlibgit2-main.tar.gz
Merge branch 'worktree_prunable' (PR #5712)HEADmain
Diffstat (limited to 'include')
-rw-r--r--include/git2/worktree.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/include/git2/worktree.h b/include/git2/worktree.h
index bb024dc94..9193eaf34 100644
--- a/include/git2/worktree.h
+++ b/include/git2/worktree.h
@@ -237,7 +237,9 @@ GIT_EXTERN(int) git_worktree_prune_options_init(
*
* If the worktree is not valid and not locked or if the above
* flags have been passed in, this function will return a
- * positive value.
+ * positive value. If the worktree is not prunable, an error
+ * message will be set (visible in `giterr_last`) with details about
+ * why.
*
* @param wt Worktree to check.
* @param opts The prunable options.