Skip to content

Commit

Permalink
fix: doc: API cli change not documented about implicit HEAD remov…
Browse files Browse the repository at this point in the history
…ed in revision list specifier. (fixes vaab#81)

In 2.5.1, ``gitchangelog show ^3.0.0`` command would implicitly add a
``HEAD`` in the revlist specifiers, effectively being equivalent to
``0.0.3..HEAD``.

This behavior is removed in 3.0.0+ to stick to ``git rev-list REVLIST``
syntax.  As a consequence, ``gitchangelog ^3.0.0`` won't select any
revision and thus will cast an error about no commits matching revlist.
  • Loading branch information
vaab committed Apr 23, 2017
1 parent 0ca081a commit e559343
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -439,7 +439,7 @@ REVLIST``. Examples follows::
gitchangelog 0.0.2..0.0.3

## will output only tags since 0.0.3 (excluded)
gitchangelog ^0.0.3
gitchangelog ^0.0.3 HEAD

## will output all tags up to 0.0.3 (included)
gitchangelog 0.0.3
Expand Down

0 comments on commit e559343

Please sign in to comment.