diff options
| author | Edward Thomson <ethomson@edwardthomson.com> | 2023-05-16 12:40:16 +0100 |
|---|---|---|
| committer | Edward Thomson <ethomson@edwardthomson.com> | 2023-05-16 12:40:16 +0100 |
| commit | 12b54ae00948a7a8422af53a8e98a5aa4d51f1f7 (patch) | |
| tree | b01428dbfdd3e41123aa8cbee3da857affd839e5 | |
| parent | 372143244dc82551eccb0503ef58d9850d530346 (diff) | |
| download | libgit2-12b54ae00948a7a8422af53a8e98a5aa4d51f1f7.tar.gz | |
worktree: document that is_prunable sets error messages
When a worktree is not prunable, an error message will be set with
information about why. Document that.
| -rw-r--r-- | include/git2/worktree.h | 4 |
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. |