diff options
| author | Carlos Martín Nieto <cmn@dwim.me> | 2016-10-05 12:55:53 +0200 |
|---|---|---|
| committer | Carlos Martín Nieto <cmn@dwim.me> | 2016-10-06 11:04:55 +0200 |
| commit | 82d4c0e6b841ae0e466bd97ab1faec0920a6b7a2 (patch) | |
| tree | c3d52eb09658ab90866824d6dd41e93926c7738e /include/git2 | |
| parent | ea1ceb7f554da276ffb0fe18c6ca4a0233845d55 (diff) | |
| download | libgit2-82d4c0e6b841ae0e466bd97ab1faec0920a6b7a2.tar.gz | |
revwalk: update the description for the default sorting
It changed from implementation-defined to git's default sorting, as there are
systems (e.g. rebase) which depend on this order. Also specify more explicitly
how you can get git's "date-order".
Diffstat (limited to 'include/git2')
| -rw-r--r-- | include/git2/revwalk.h | 10 |
1 files changed, 4 insertions, 6 deletions
diff --git a/include/git2/revwalk.h b/include/git2/revwalk.h index 2cc00536e..d9376ceea 100644 --- a/include/git2/revwalk.h +++ b/include/git2/revwalk.h @@ -25,17 +25,15 @@ GIT_BEGIN_DECL */ typedef enum { /** - * Sort the repository contents in no particular ordering; - * this sorting is arbitrary, implementation-specific - * and subject to change at any time. + * Sort the output with the same default time-order method from git. * This is the default sorting for new walkers. */ GIT_SORT_NONE = 0, /** - * Sort the repository contents in topological order - * (parents before children); this sorting mode - * can be combined with time sorting. + * Sort the repository contents in topological order (parents before + * children); this sorting mode can be combined with time sorting to + * produce git's "time-order". */ GIT_SORT_TOPOLOGICAL = 1 << 0, |