Merge pull request #2868 from ethomson/diff_doc diff docs: update `git_diff_delta` description
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
diff --git a/include/git2/diff.h b/include/git2/diff.h
index 4403944..9fcc3bb 100644
--- a/include/git2/diff.h
+++ b/include/git2/diff.h
@@ -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
diff --git a/include/git2/patch.h b/include/git2/patch.h
index 47c3956..790cb74 100644
--- a/include/git2/patch.h
+++ b/include/git2/patch.h
@@ -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);