diff options
| author |  Jonathan Nieder <jrnieder@gmail.com> | 2020-01-03 16:13:31 -0800 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2020-01-06 08:44:24 -0800 |
| commit | 60440d72db4c9f2fc05b841813e72159c4f08928 (patch) | |
| tree | 2bc28ab59a2138996ad102578c7e4947aa222a66 /t/t4051-diff-function-context.sh | |
| parent | Git 2.24.1 (diff) | |
| download | tgif-60440d72db4c9f2fc05b841813e72159c4f08928.tar.xz | |
sha1-file: document how to use pretend_object_file
Like in-memory alternates, pretend_object_file contains a trap for the
unwary: careless callers can use it to create references to an object
that does not exist in the on-disk object store.
Add a comment documenting how to use the function without risking such
problems.
The only current caller is blame, which uses pretend_object_file to
create an in-memory commit representing the working tree state.
Noticed during a discussion of how to safely use this function in
operations like "git merge" which, unlike blame, are not read-only.
Inspired-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 't/t4051-diff-function-context.sh')
0 files changed, 0 insertions, 0 deletions