Skip to content

Commit a5a4892

Browse files
committed
Add note about git describe
1 parent b18c53e commit a5a4892

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,9 @@ and uses roughly the following logic to render the version:
123123
The next version is calculated by adding ``1`` to the last numeric component
124124
of the tag.
125125

126+
For git projects, the version is version is relies on `git describe <https://git-scm.com/docs/git-describe>`_,
127+
so you will see an additional ``g`` prepended to the ``{revision hash}``.
128+
126129
Semantic Versioning (SemVer)
127130
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
128131

0 commit comments

Comments
 (0)