diff options
| author | Ben Straub <bs@github.com> | 2014-02-05 13:15:57 -0800 |
|---|---|---|
| committer | Ben Straub <bs@github.com> | 2014-02-05 13:15:57 -0800 |
| commit | 0de2c4e3a3cb63a2af66c464585d0e9ae273ddee (patch) | |
| tree | 8a2420a6151343d5092b46a22806bad4f9b28de8 /include | |
| parent | 010cec3ac26ab8445cc8401fb312f60168916bda (diff) | |
| parent | 629ba7f1059bdc149718570a8b2ac043c044d781 (diff) | |
| download | libgit2-0de2c4e3a3cb63a2af66c464585d0e9ae273ddee.tar.gz | |
Merge remote-tracking branch 'libgit2/development' into bs/more-reflog-stuff
Diffstat (limited to 'include')
| -rw-r--r-- | include/git2/revwalk.h | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/include/git2/revwalk.h b/include/git2/revwalk.h index c59b79938..aef0b5fa6 100644 --- a/include/git2/revwalk.h +++ b/include/git2/revwalk.h @@ -87,7 +87,7 @@ GIT_EXTERN(void) git_revwalk_reset(git_revwalk *walker); /** * Mark a commit to start traversal from. * - * The given OID must belong to a commit on the walked + * The given OID must belong to a committish on the walked * repository. * * The given commit will be used as one of the roots @@ -108,7 +108,10 @@ GIT_EXTERN(int) git_revwalk_push(git_revwalk *walk, const git_oid *id); * pattern will be pushed to the revision walker. * * A leading 'refs/' is implied if not present as well as a trailing - * '/ *' if the glob lacks '?', '*' or '['. + * '/\*' if the glob lacks '?', '\*' or '['. + * + * Any references matching this glob which do not point to a + * committish will be ignored. * * @param walk the walker being used for the traversal * @param glob the glob pattern references should match @@ -127,7 +130,7 @@ GIT_EXTERN(int) git_revwalk_push_head(git_revwalk *walk); /** * Mark a commit (and its ancestors) uninteresting for the output. * - * The given OID must belong to a commit on the walked + * The given OID must belong to a committish on the walked * repository. * * The resolved commit and all its parents will be hidden from the @@ -147,7 +150,10 @@ GIT_EXTERN(int) git_revwalk_hide(git_revwalk *walk, const git_oid *commit_id); * revision walk. * * A leading 'refs/' is implied if not present as well as a trailing - * '/ *' if the glob lacks '?', '*' or '['. + * '/\*' if the glob lacks '?', '\*' or '['. + * + * Any references matching this glob which do not point to a + * committish will be ignored. * * @param walk the walker being used for the traversal * @param glob the glob pattern references should match @@ -166,7 +172,7 @@ GIT_EXTERN(int) git_revwalk_hide_head(git_revwalk *walk); /** * Push the OID pointed to by a reference * - * The reference must point to a commit. + * The reference must point to a committish. * * @param walk the walker being used for the traversal * @param refname the reference to push @@ -177,7 +183,7 @@ GIT_EXTERN(int) git_revwalk_push_ref(git_revwalk *walk, const char *refname); /** * Hide the OID pointed to by a reference * - * The reference must point to a commit. + * The reference must point to a committish. * * @param walk the walker being used for the traversal * @param refname the reference to hide |