worktree: update documentation for lock_reason and lock_reason_valid
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>
Nickolai Belakovski committed
Oct 29, 2018 at 23:24 UTC
e21cc076a31c8f6a39946f914338aa4dd6c9de3d
1 file changed
+2
-2
worktree.h
+2
-2
@@ -10,12 +10,12 @@ struct worktree {
10
char *path;
11
char *id;
12
char *head_ref; /* NULL if HEAD is broken or detached */
13
- char *lock_reason; /* internal use */
13
+ char *lock_reason; /* private - use is_worktree_locked */
14
struct object_id head_oid;
15
int is_detached;
16
int is_bare;
17
int is_current;
18
- int lock_reason_valid;
18
+ int lock_reason_valid; /* private */
19
};
20
21
/* Functions for acting on the information about worktrees. */