summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorRonny Pfannschmidt <ronny.pfannschmidt@redhat.com>2020-12-06 17:12:15 +0100
committerRonny Pfannschmidt <ronny.pfannschmidt@redhat.com>2020-12-06 17:48:36 +0100
commit50f0933809f2b1d46e792a6f7ca872c208dffcdc (patch)
tree4c61a51aa9f6bc9b344c207fa51824f7a8ccc356 /README.rst
parent6b444b930e95d8487c30534d9dab083739e497f8 (diff)
downloadsetuptools-scm-50f0933809f2b1d46e792a6f7ca872c208dffcdc.tar.gz
fix #213: better error on nonzero dev versions
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index a826b1f..f9193c1 100644
--- a/README.rst
+++ b/README.rst
@@ -277,6 +277,7 @@ distance and not clean:
The next version is calculated by adding ``1`` to the last numeric component of
the tag.
+
For Git projects, the version relies on `git describe <https://git-scm.com/docs/git-describe>`_,
so you will see an additional ``g`` prepended to the ``{revision hash}``.
@@ -507,6 +508,8 @@ Version number construction
:guess-next-dev: Automatically guesses the next development version (default).
Guesses the upcoming release by incrementing the pre-release segment if present,
otherwise by incrementing the micro segment. Then appends :code:`.devN`.
+ In case the tag ends with ``.dev0`` the version is not bumped
+ and custom ``.devN`` versions will trigger a error.
:post-release: generates post release versions (adds :code:`.postN`)
:python-simplified-semver: Basic semantic versioning. Guesses the upcoming release
by incrementing the minor segment and setting the micro segment to zero if the