Doc fixes
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
diff --git a/include/git2/merge.h b/include/git2/merge.h
index ef2dc38..abbc3a5 100644
--- a/include/git2/merge.h
+++ b/include/git2/merge.h
@@ -61,7 +61,7 @@ GIT_EXTERN(int) git_merge_file_init_input(
/**
* Flags for `git_merge_tree` options. A combination of these flags can be
- * passed in via the `flags` value in the `git_merge_tree_opts`.
+ * passed in via the `flags` value in the `git_merge_options`.
*/
typedef enum {
/**
@@ -73,7 +73,7 @@ typedef enum {
} git_merge_tree_flag_t;
/**
- * Merge file favor options for `git_merge_trees_opts` instruct the file-level
+ * Merge file favor options for `git_merge_options` instruct the file-level
* merging functionality how to deal with conflicting regions of the files.
*/
typedef enum {
diff --git a/include/git2/object.h b/include/git2/object.h
index 7417ea9..9b13d82 100644
--- a/include/git2/object.h
+++ b/include/git2/object.h
@@ -107,6 +107,11 @@ GIT_EXTERN(const git_oid *) git_object_id(const git_object *obj);
/**
* Get a short abbreviated OID string for the object
*
+ * This starts at the "core.abbrev" length (default 7 characters) and
+ * iteratively extends to a longer string if that length is ambiguous.
+ * The result will be unambiguous (at least until new objects are added to
+ * the repository).
+ *
* @param out Buffer to write string into
* @param obj The object to get an ID for
* @return 0 on success, <0 for error