Commit 471b10bd by Carlos Martín Nieto

Merge pull request #2868 from ethomson/diff_doc

diff docs: update `git_diff_delta` description
parents f83c19c8 3538f8f1
...@@ -849,9 +849,9 @@ GIT_EXTERN(size_t) git_diff_num_deltas_of_type( ...@@ -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. * Return the diff delta for an entry in the diff list.
* *
* The `git_delta` pointer points to internal data and you do not have * The `git_diff_delta` pointer points to internal data and you do not
* to release it when you are done with it. It will go away when the * have to release it when you are done with it. It will go away when
* `git_diff` (or any associated `git_patch`) goes away. * the * `git_diff` (or any associated `git_patch`) goes away.
* *
* Note that the flags on the delta related to whether it has binary * 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 * content or not may not be set if there are no attributes set for the
......
...@@ -29,7 +29,7 @@ GIT_BEGIN_DECL ...@@ -29,7 +29,7 @@ GIT_BEGIN_DECL
typedef struct git_patch git_patch; 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 * 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 * for the delta. You have to call `git_patch_free()` when you are
...@@ -40,10 +40,6 @@ typedef struct git_patch git_patch; ...@@ -40,10 +40,6 @@ typedef struct git_patch git_patch;
* created, the output will be set to NULL, and the `binary` flag will be * created, the output will be set to NULL, and the `binary` flag will be
* set true in the `git_diff_delta` structure. * 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 * 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. * NULL for the `git_patch`, then the text diff will not be calculated.
* *
...@@ -139,7 +135,8 @@ GIT_EXTERN(int) git_patch_from_buffers( ...@@ -139,7 +135,8 @@ GIT_EXTERN(int) git_patch_from_buffers(
GIT_EXTERN(void) git_patch_free(git_patch *patch); 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); GIT_EXTERN(const git_diff_delta *) git_patch_get_delta(const git_patch *patch);
......
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