From be44727e0e48309e33b32e4d7eeee94279ae2d9c Mon Sep 17 00:00:00 2001 From: brycegbrazen Date: Thu, 11 Jan 2024 18:17:45 -0600 Subject: [PATCH 1/2] Add semantic versioning warning Signed-off-by: brycegbrazen --- docs/source/basic_concepts.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/source/basic_concepts.rst b/docs/source/basic_concepts.rst index 34d2d01fd..c3b7dd851 100644 --- a/docs/source/basic_concepts.rst +++ b/docs/source/basic_concepts.rst @@ -81,6 +81,13 @@ version than ``1.0``. a version number doesn't matter, you can have as many as you like. While you are encouraged to use semantic versioning (see ``_), it is not enforced. +.. note:: + If you are using semantic versioning, please note that version ordering will NOT behave like described + in the semantic versioning 2.0.0 spec. Rez gives no special bearing to "pre release" identifiers (as defined by + semantic versioning). + + Ex. foo-1.0.0 < foo-1.0.0-beta.1 + .. _packages-concept: Packages From 75603b93e75faa4de70a9645858947c932863ff9 Mon Sep 17 00:00:00 2001 From: brycegbrazen Date: Fri, 12 Jan 2024 10:18:45 -0600 Subject: [PATCH 2/2] Merge the two notes Signed-off-by: brycegbrazen --- docs/source/basic_concepts.rst | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/source/basic_concepts.rst b/docs/source/basic_concepts.rst index c3b7dd851..01f53bfef 100644 --- a/docs/source/basic_concepts.rst +++ b/docs/source/basic_concepts.rst @@ -78,13 +78,11 @@ version than ``1.0``. .. note:: No special importance is given to specific characters or letters in Rez version numbers. The terms ``alpha`` and ``beta`` for example have no special meaning. Similarly, the number of tokens in - a version number doesn't matter, you can have as many as you like. While you are encouraged to use - semantic versioning (see ``_), it is not enforced. + a version number doesn't matter, you can have as many as you like. -.. note:: - If you are using semantic versioning, please note that version ordering will NOT behave like described - in the semantic versioning 2.0.0 spec. Rez gives no special bearing to "pre release" identifiers (as defined by - semantic versioning). + While you are encouraged to use semantic versioning (see ``_), it is not enforced. Please note + that if you are using semantic versioning, version ordering will NOT behave like described in the semantic versioning + 2.0.0 spec. Ex. foo-1.0.0 < foo-1.0.0-beta.1