From e55934378a1200c3cdc51d5ba8691d51791ea67f Mon Sep 17 00:00:00 2001 From: Valentin Lab Date: Sun, 23 Apr 2017 08:40:36 +0800 Subject: [PATCH] fix: doc: API cli change not documented about implicit ``HEAD`` removed in revision list specifier. (fixes #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. --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 227e167..22eebfd 100644 --- a/README.rst +++ b/README.rst @@ -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