summaryrefslogtreecommitdiff
path: root/worktree.h
diff options
context:
space:
mode:
authorNickolai Belakovski <nbelakovski@gmail.com>2018-10-30 06:24:08 (GMT)
committerJunio C Hamano <gitster@pobox.com>2018-10-31 02:28:52 (GMT)
commite21cc076a31c8f6a39946f914338aa4dd6c9de3d (patch)
tree48a43881eaedbf537c32061092ec8ac5bb017fcc /worktree.h
parent4ede3d42dfb57f9a41ac96a1f216c62eb7566cc2 (diff)
downloadgit-e21cc076a31c8f6a39946f914338aa4dd6c9de3d.zip
git-e21cc076a31c8f6a39946f914338aa4dd6c9de3d.tar.gz
git-e21cc076a31c8f6a39946f914338aa4dd6c9de3d.tar.bz2
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>
Diffstat (limited to 'worktree.h')
-rw-r--r--worktree.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/worktree.h b/worktree.h
index df3fc30..6b12a3c 100644
--- a/worktree.h
+++ b/worktree.h
@@ -10,12 +10,12 @@ struct worktree {
char *path;
char *id;
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;
int is_detached;
int is_bare;
int is_current;
- int lock_reason_valid;
+ int lock_reason_valid; /* private */
};
/* Functions for acting on the information about worktrees. */