summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorMichael Haggerty <mhagger@alum.mit.edu>2014-10-01 10:28:39 (GMT)
committerJunio C Hamano <gitster@pobox.com>2014-10-01 20:53:54 (GMT)
commitec38b4e482e96e62762452cab5714e55abdb48c3 (patch)
tree7b9e0268013d641289da53c9630ebd7af5aba8d7 /Documentation
parent316683bd37608e31cc3f5e932c4e5c7dde1b39f0 (diff)
downloadgit-ec38b4e482e96e62762452cab5714e55abdb48c3.zip
git-ec38b4e482e96e62762452cab5714e55abdb48c3.tar.gz
git-ec38b4e482e96e62762452cab5714e55abdb48c3.tar.bz2
get_locked_file_path(): new function
Add a function to return the path of the file that is locked by a lock_file object. This reduces the knowledge that callers have to have about the lock_file layout. Suggested-by: Ronnie Sahlberg <sahlberg@google.com> Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/technical/api-lockfile.txt5
1 files changed, 5 insertions, 0 deletions
diff --git a/Documentation/technical/api-lockfile.txt b/Documentation/technical/api-lockfile.txt
index a3cb69b..d4484d1 100644
--- a/Documentation/technical/api-lockfile.txt
+++ b/Documentation/technical/api-lockfile.txt
@@ -143,6 +143,11 @@ hold_lock_file_for_append::
the existing contents of the file (if any) to the lockfile and
position its write pointer at the end of the file.
+get_locked_file_path::
+
+ Return the path of the file that is locked by the specified
+ lock_file object. The caller must free the memory.
+
commit_lock_file::
Take a pointer to the `struct lock_file` initialized with an