git/Documentation/technical/api-lockfile.txt, branch v1.6.3Mirror of https://git.kernel.org/pub/scm/git/git.git/
https://git.shady.money/git/atom?h=v1.6.32008-01-16T23:35:03Zclose_lock_file(): new function in the lockfile API2008-01-16T23:35:03ZBrandon Caseycasey@nrlssc.navy.mil2008-01-16T19:05:32Zurn:sha1:d6cf61bfd4bccffcc8b095f8469dbe749d70abdf
The lockfile API is a handy way to obtain a file that is cleaned
up if you die(). But sometimes you would need this sequence to
work:
1. hold_lock_file_for_update() to get a file descriptor for
writing;
2. write the contents out, without being able to decide if the
results should be committed or rolled back;
3. do something else that makes the decision --- and this
"something else" needs the lockfile not to have an open file
descriptor for writing (e.g. Windows do not want a open file
to be renamed);
4. call commit_lock_file() or rollback_lock_file() as
appropriately.
This adds close_lock_file() you can call between step 2 and 3 in
the above sequence.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Document lockfile API2008-01-16T20:42:37ZJunio C Hamanogitster@pobox.com2008-01-16T19:00:13Zurn:sha1:0c0478cac87991bd555e81715e9332d11eecd881
We have nice set of placeholders, but nobody stepped in to fill
the gap in the API documentation, so I am doing it myself.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Start preparing the API documents.2007-12-15T06:29:38ZJunio C Hamanogitster@pobox.com2007-11-25T07:48:04Zurn:sha1:530e741c726a612d78de21957d531dd2215483b4
Most of them are still stubs, but the procedure to build the HTML
documentation, maintaining the index and installing the end product are
there.
I placed names of people who are likely to know the most about the topic
in the stub files, so that volunteers will know whom to ask questions as
needed.
Signed-off-by: Junio C Hamano <gitster@pobox.com>