undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

worktree: update documentation for lock_reason and lock_reason_valid

Browse Source 
Clarify that these fields are to be considered implementation details
and direct the reader to use the is_worktree_locked function to retrieve
said information.

Signed-off-by: Nickolai Belakovski <nbelakovski@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Nickolai Belakovski 2018-10-29 23:24:08 -07:00 committed by Junio C Hamano
parent 4ede3d42df
commit e21cc076a3
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
worktree.h
View File

@ -10,12 +10,12 @@ struct worktree {
char *path; char *path;
char *id; char *id;
char *head_ref; /* NULL if HEAD is broken or detached */ char *head_ref; /* NULL if HEAD is broken or detached */
char *lock_reason; /* internal use */ char *lock_reason; /* private - use is_worktree_locked */
struct object_id head_oid; struct object_id head_oid;
int is_detached; int is_detached;
int is_bare; int is_bare;
int is_current; int is_current;
int lock_reason_valid; int lock_reason_valid; /* private */
}; };
/* Functions for acting on the information about worktrees. */ /* Functions for acting on the information about worktrees. */