doc: also consider "-" as version number separator char

Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr>

Author: xdelaruelle

NEWS.rst

@@ -108,6 +108,9 @@ Modules 5.7.0 (not yet released)
   test suite run is aborted.
 * Correctly match loaded modules specified as requirement with a trailing
   ``/`` character after module name. (fix issue #640)
+* Also consider ``-`` in addition to ``.`` as a version number separator
+  character when selecting a module with the :mconfig:`extended_default`
+  mechanism. (fix issue #619)
 
 
 .. _5.6 release notes:

doc/source/changes.rst

@@ -764,6 +764,9 @@ Starting version 5.5, characters ``+`` and ``~`` may be part of module name or
 version as long as the string part next to these character is not a valid
 variant name.
 
+Starting version 5.7, character ``-`` is considered a version number separator
+for :mconfig:`extended_default` mechanism.
+
 Environment
 """""""""""
 

doc/source/design/extended-default.rst

@@ -25,15 +25,16 @@ Specification
   - query soft/1 returns nothing
   - query soft/10.1.2 returns highest among soft/10.1.2.4 soft/10.1.2.3
 
-- In situation where soft/1.1(default) soft/1.2 soft/2.1 soft/2.2
+- In situation where soft/1.1(default) soft/1.2 soft/2.1 soft/2.2 soft/3.4-ad75bc9a
 
   - query soft/1 returns soft/1.1
   - query soft/2 returns soft/2.2
+  - query soft/3.4 returns soft/3.4-ad75bc9a
 
-- Character considered as version number separator: ``.``
+- Characters considered as version number separator: ``.`` and ``-``
 
   - list: ``.`` and ``-``
-  - ``-`` was also considered initially, but cannot determine in all case the highest version specified after this character (may find a hash name, strings like *rc*, *alpha*, *beta*, etc)
+  - ``-`` is considered a version number separator character since version 5.7
   - not possible with ``+`` as it is used by variant specification
 
 - Does not apply to the root part of module name

doc/source/module.rst

@@ -3146,8 +3146,9 @@ Constraints can be expressed to refine the selection of module version to:
 Advanced specification of single version or list of versions may benefit from
 the activation of the extended default mechanism (see
 :envvar:`MODULES_EXTENDED_DEFAULT`) to use an abbreviated notation like ``@1``
-to refer to more precise version numbers like ``1.2.3``. Range of versions on
-its side natively handles abbreviated versions.
+to refer to more precise version numbers like ``1.2.3``. Characters ``.`` and
+``-`` are considered version number separator to determine abbreviated
+versions. Range of versions on its side natively handles abbreviated versions.
 
 In order to be specified in a range of versions or compared to a range of
 versions, the version major element should corresponds to a number. For
@@ -5008,9 +5009,9 @@ ENVIRONMENT
 
  If set to ``1``, a specified module version is matched against starting
  portion of existing module versions, where portion is a substring separated
- from the rest of the version string by a ``.`` character. For example
+ from the rest of the version string by ``.`` or ``-`` characters. For example
  specified modules ``mod/1`` and ``mod/1.2`` will match existing modulefile
- ``mod/1.2.3``.
+ ``mod/1.2.3`` and ``mod/2.4`` will match ``mod/2.4-91db5cf2``.
 
  In case multiple modulefiles match the specified module version and a single
  module has to be selected, the explicitly set default version is returned if
@@ -5026,6 +5027,9 @@ ENVIRONMENT
 
     .. versionadded:: 4.4
 
+    .. versionchanged:: 5.7
+       Character ``-`` is also considered a version number separator
+
 .. envvar:: MODULES_FAMILY_<NAME>
 
  Module name minus version that provides for the *name* family in currently

doc/source/modulefile.rst

@@ -1949,8 +1949,8 @@ The equivalent :file:`.modulerc` would look like:
 If the extended default mechanism is enabled (see
 :envvar:`MODULES_EXTENDED_DEFAULT` in :ref:`module(1)`) the module version
 specified is matched against starting portion of existing module versions,
-where portion is a substring separated from the rest of version string by a
-``.`` character.
+where portion is a substring separated from the rest of version string by
+``.`` or ``-`` characters.
 
 When the implicit default mechanism and the `Advanced module version
 specifiers`_ are both enabled, a ``default`` and ``latest`` symbolic versions
@@ -2081,7 +2081,9 @@ Advanced specification of single version or list of versions may benefit from
 the activation of the extended default mechanism (see
 :envvar:`MODULES_EXTENDED_DEFAULT` in :ref:`module(1)`) to use an abbreviated
 notation like ``@1`` to refer to more precise version numbers like ``1.2.3``.
-Range of versions on its side natively handles abbreviated versions.
+Characters ``.`` and ``-`` are considered version number separator to
+determine abbreviated versions. Range of versions on its side natively handles
+abbreviated versions.
 
 In order to be specified in a range of versions or compared to a range of
 versions, the version major element should corresponds to a number. For
@@ -2109,6 +2111,9 @@ version will be selected.
    .. versionchanged:: 4.8
       Use of version range is allowed in version list
 
+   .. versionchanged:: 5.7
+      Character ``-`` is also considered a version number separator
+
 Variants
 ^^^^^^^^