Skip to content

Commit e21cc07

Browse files
nbelakovskigitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 4ede3d4 commit e21cc07

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

worktree.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ struct worktree {
1010
char *path;
1111
char *id;
1212
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 */
1414
struct object_id head_oid;
1515
int is_detached;
1616
int is_bare;
1717
int is_current;
18-
int lock_reason_valid;
18+
int lock_reason_valid; /* private */
1919
};
2020

2121
/* Functions for acting on the information about worktrees. */

0 commit comments

Comments
 (0)