Idea-Studios/libgit2
2
0
Fork 0
mirror of https://github.com/libgit2/libgit2.git synced 2026-06-22 06:26:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

worktree: document that is_prunable sets error messages

Browse Source 
When a worktree is not prunable, an error message will be set with
information about why. Document that.
This commit is contained in:
Edward Thomson
2023-05-16 12:40:16 +01:00
parent 372143244d
commit 12b54ae009
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
include/git2/worktree.h
View File

@@ -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.