diff options
author | Ben Straub <bs@github.com> | 2013-03-11 20:27:16 -0700 |
---|---|---|
committer | Ben Straub <bs@github.com> | 2013-04-08 16:36:11 +0400 |
commit | 8480eef7ee0c8e52a8bf3ea12e5626009a966164 (patch) | |
tree | 0c48cd9c10af146fd1203ed3d830cdfdaa620092 /include/git2/revparse.h | |
parent | 4d13d07ab21d5041dc3b2e77c9447298d6b39eaa (diff) | |
download | libgit2-8480eef7ee0c8e52a8bf3ea12e5626009a966164.tar.gz |
Implement unified git_revparse
Diffstat (limited to 'include/git2/revparse.h')
-rw-r--r-- | include/git2/revparse.h | 34 |
1 files changed, 18 insertions, 16 deletions
diff --git a/include/git2/revparse.h b/include/git2/revparse.h index 71ff6d696..9315b66eb 100644 --- a/include/git2/revparse.h +++ b/include/git2/revparse.h @@ -51,35 +51,37 @@ GIT_EXTERN(int) git_revparse_rangelike(git_object **left, git_object **right, in * git_revparse. */ typedef enum { - /** The spec targeted a single object. */ - GIT_REVPARSE_SINGLE = 1 << 0, - /** The spec targeted a range of commits. */ - GIT_REVPARSE_RANGE = 1 << 1, - /** The spec used the '...' operator, which invokes special semantics. */ - GIT_REVPARSE_MERGE_BASE = 1 << 2, + /** The spec targeted a single object. */ + GIT_REVPARSE_SINGLE = 1 << 0, + /** The spec targeted a range of commits. */ + GIT_REVPARSE_RANGE = 1 << 1, + /** The spec used the '...' operator, which invokes special semantics. */ + GIT_REVPARSE_MERGE_BASE = 1 << 2, } git_revparse_flag_t; /** - * Find an object or range of commits as specified by a revision string. - * See `man gitrevisions` or http://git-scm.com/docs/git-rev-parse.html#_specifying_revisions - * for information on the syntax accepted. + * Parse a revision string for left, right, and intent. See `man gitrevisions` or + * http://git-scm.com/docs/git-rev-parse.html#_specifying_revisions for information + * on the syntax accepted. * * @param left buffer that receives the target of the left side of a range operator. If * there is no range operator, this buffer receives the single target. * @param right buffer that receives the target of the right side of a range operator. - * This is only filled in if `spec` specifies a range of commits - * @param flags buffer that receives a bitwise combination of `git_revparse_flag_t` values + * This is only filled in if `spec` specifies a range of commits. May + * be NULL. + * @param flags buffer that receives a bitwise combination of `git_revparse_flag_t` values. + * May be NULL. * @param repo the repository to search in * @param spec the rev-parse spec to parse * @return 0 on success, GIT_INVALIDSPEC, GIT_ENOTFOUND, GIT_EAMBIGUOUS or an error code */ GIT_EXTERN(int) git_revparse( - git_oid *left, - git_oid *right, - unsigned int *flags, - git_repository *repo, - const char *spec); + git_oid *left, + git_oid *right, + unsigned int *flags, + git_repository *repo, + const char *spec); /** @} */ |