]> git.proxmox.com Git - libgit2.git/commitdiff
Doc fixes
authorRussell Belfer <rb@github.com>
Fri, 2 May 2014 22:15:43 +0000 (15:15 -0700)
committerRussell Belfer <rb@github.com>
Fri, 2 May 2014 22:15:43 +0000 (15:15 -0700)
include/git2/merge.h
include/git2/object.h

index ef2dc38042e542a78a6fd874906f351ee961bce1..abbc3a5bb314ae24fa529ac3c6a2522c69246074 100644 (file)
@@ -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 {
index 7417ea913748246bf49d9bccd55721a34776549c..9b13d824efb823a45e371fd5d89091025804c121 100644 (file)
@@ -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