diff options
Diffstat (limited to 'include/git2/diff.h')
-rw-r--r-- | include/git2/diff.h | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/include/git2/diff.h b/include/git2/diff.h index 6afa608bb..bafe6268c 100644 --- a/include/git2/diff.h +++ b/include/git2/diff.h @@ -337,12 +337,21 @@ GIT_EXTERN(int) git_diff_print_patch( /** * 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_blob *old_blob, git_blob *new_blob, git_diff_options *options, void *cb_data, + git_diff_file_fn file_cb, git_diff_hunk_fn hunk_cb, git_diff_data_fn line_cb); |