proxmox-mirrors/libgit2
1
0
Fork 0
mirror of https://git.proxmox.com/git/libgit2 synced 2025-07-06 09:04:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

diff docs: update git_diff_delta description

Browse Source
This commit is contained in:
Edward Thomson 2015-02-03 13:41:35 -05:00
parent f83c19c87d
commit 3538f8f131
2 changed files with 6 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
include/git2/diff.h
View File

@ -849,9 +849,9 @@ GIT_EXTERN(size_t) git_diff_num_deltas_of_type(
/**
* Return the diff delta for an entry in the diff list.
*
* The `git_delta` pointer points to internal data and you do not have
* to release it when you are done with it. It will go away when the
* `git_diff` (or any associated `git_patch`) goes away.
* The `git_diff_delta` pointer points to internal data and you do not
* have to release it when you are done with it. It will go away when
* the * `git_diff` (or any associated `git_patch`) goes away.
*
* Note that the flags on the delta related to whether it has binary
* content or not may not be set if there are no attributes set for the

9
include/git2/patch.h
View File

@ -29,7 +29,7 @@ GIT_BEGIN_DECL
typedef struct git_patch git_patch;
/**
* Return the diff delta and patch for an entry in the diff list.
* Return a patch for an entry in the diff list.
*
* The `git_patch` is a newly created object contains the text diffs
* for the delta. You have to call `git_patch_free()` when you are
@ -40,10 +40,6 @@ typedef struct git_patch git_patch;
* created, the output will be set to NULL, and the `binary` flag will be
* set true in the `git_diff_delta` structure.
*
* The `git_diff_delta` pointer points to internal data and you do not have
* to release it when you are done with it. It will go away when the
* `git_diff` and `git_patch` go away.
*
* It is okay to pass NULL for either of the output parameters; if you pass
* NULL for the `git_patch`, then the text diff will not be calculated.
*
@ -139,7 +135,8 @@ GIT_EXTERN(int) git_patch_from_buffers(
GIT_EXTERN(void) git_patch_free(git_patch *patch);
/**
* Get the delta associated with a patch
* Get the delta associated with a patch. This delta points to internal
* data and you do not have to release it when you are done with it.
*/
GIT_EXTERN(const git_diff_delta *) git_patch_get_delta(const git_patch *patch);