path: root/Documentation/technical
diff options
authorMichael Haggerty <>2014-10-01 10:28:21 (GMT)
committerJunio C Hamano <>2014-10-01 20:45:13 (GMT)
commit8a1c7533e2ee468a505656abab364780b15004fc (patch)
tree59186c6a8bf85d653d1075842ffbfaff61ca898d /Documentation/technical
parent4f4713df94e2f3d3adbd39b8fce571e2bd69185e (diff)
commit_lock_file(): die() if called for unlocked lockfile object
It was previously a bug to call commit_lock_file() with a lock_file object that was not active (an illegal access would happen within the function). It was presumably never done, but this would be an easy programming error to overlook. So before continuing, do a consistency check that the lock_file object really is locked. Helped-by: Johannes Sixt <> Signed-off-by: Michael Haggerty <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/technical')
1 files changed, 2 insertions, 1 deletions
diff --git a/Documentation/technical/api-lockfile.txt b/Documentation/technical/api-lockfile.txt
index 99830f3..6538610 100644
--- a/Documentation/technical/api-lockfile.txt
+++ b/Documentation/technical/api-lockfile.txt
@@ -147,7 +147,8 @@ commit_lock_file::
`hold_lock_file_for_append`, close the file descriptor and
rename the lockfile to its final destination. Return 0 upon
success or a negative value on failure to `close(2)` or
- `rename(2)`.
+ `rename(2)`. It is a bug to call `commit_lock_file()` for a
+ `lock_file` object that is not currently locked.