Commit d1c4312a by nulltoken

diff: improve git_diff_blobs() documentation

parent 9a29f8d5
...@@ -337,6 +337,14 @@ GIT_EXTERN(int) git_diff_print_patch( ...@@ -337,6 +337,14 @@ GIT_EXTERN(int) git_diff_print_patch(
/** /**
* Directly run a text diff on two blobs. * Directly run a text diff on two blobs.
*
* Compared to a file, a blob lacks some contextual information. As such, the
* `git_diff_file` parameters of the callbacks will be filled accordingly to the following:
* `mode` will be set to 0, `path` will be set to NULL. When dealing with a NULL blob, `oid`
* will be set to 0.
*
* When at least one of the blobs being dealt with is binary, the `git_diff_delta` binary
* attribute will be set to 1 and no call to the hunk_cb nor line_cb will be made.
*/ */
GIT_EXTERN(int) git_diff_blobs( GIT_EXTERN(int) git_diff_blobs(
git_blob *old_blob, git_blob *old_blob,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment