Commit d2c16e9a by Russell Belfer

Doc fixes

parent 272b462d
...@@ -61,7 +61,7 @@ GIT_EXTERN(int) git_merge_file_init_input( ...@@ -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 * 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 { typedef enum {
/** /**
...@@ -73,7 +73,7 @@ typedef enum { ...@@ -73,7 +73,7 @@ typedef enum {
} git_merge_tree_flag_t; } 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. * merging functionality how to deal with conflicting regions of the files.
*/ */
typedef enum { typedef enum {
......
...@@ -107,6 +107,11 @@ GIT_EXTERN(const git_oid *) git_object_id(const git_object *obj); ...@@ -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 * 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 out Buffer to write string into
* @param obj The object to get an ID for * @param obj The object to get an ID for
* @return 0 on success, <0 for error * @return 0 on success, <0 for error
......
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