summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRussell Belfer <rb@github.com>2014-05-02 15:15:43 -0700
committerRussell Belfer <rb@github.com>2014-05-02 15:15:43 -0700
commitd2c16e9ac4921e94eb5db972e6b8452d71a623fc (patch)
tree19f4849922670d8475a4256179ad3a1a07c44580
parent272b462db7cfb50c1ab69e1edda214b21f242ae5 (diff)
downloadlibgit2-d2c16e9ac4921e94eb5db972e6b8452d71a623fc.tar.gz
Doc fixes
-rw-r--r--include/git2/merge.h4
-rw-r--r--include/git2/object.h5
2 files changed, 7 insertions, 2 deletions
diff --git a/include/git2/merge.h b/include/git2/merge.h
index ef2dc3804..abbc3a5bb 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 7417ea913..9b13d824e 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