doc: desc. variantifspec in NEWS/MIGRATING

Author: xdelaruelle

.aspell.en.pws

@@ -1,4 +1,4 @@
-personal_ws-1.1 en 898
+personal_ws-1.1 en 901
 ABBRVLIST
 ActiveTcl
 Adrien
@@ -738,6 +738,9 @@ sgrss
 sgrsy
 sgrtr
 sgrva
+sgrvade
+sgrvadehi
+sgrvahi
 sgrwa
 shellcheck
 shellname

MIGRATING.rst

@@ -134,6 +134,36 @@ You can also search for modules defining a specific variant value:
 .. note:: As extra match search implies additional modulefile evaluations, it
    is advised to build and use `Module cache`_ to improve search speed.
 
+Two new elements, ``variant`` and ``variantifspec``, are added to the allowed
+value list of :mconfig:`avail_output` and :mconfig:`avail_terse_output`
+configuration options. The latter is set in the default value list of both
+options. When ``variant`` is set, variants and their possible values are
+reported along module they are associated to. When ``variantifspec`` is set,
+available variants are reported only if a variant is specified in search
+query.
+
+.. parsed-literal::
+
+    :ps:`$` module config --reset avail_output
+    :ps:`$` module config avail_output
+    Modules Release 5.3.0 (2023-XX-XX)
+
+    - :sgrhi:`Config. name` ---------.- :sgrhi:`Value (set by if default overridden)` ---------------
+    avail_output              modulepath:alias:dirwsym:sym:tag:variantifspec:key
+    :ps:`$` module avail foo
+    --------------------- :sgrdi:`/path/to/modulefiles` ---------------------
+    :sgrhi:`foo`/1.0  :sgrhi:`foo`/2.0  
+
+    Key:
+    :sgrdi:`modulepath`  
+    :ps:`$` module avail foo %a
+    --------------------- :sgrdi:`/path/to/modulefiles` ---------------------
+    :sgrhi:`foo`/1.0{:sgrvadehi:`%a`}  :sgrhi:`foo`/2.0{:sgrvahi:`%a`,\ :sgrva:`b`,\ :sgrva:`c`}  
+
+    Key:
+    :sgrdi:`modulepath`       {:sgrva:`%value`}={:sgrva:`toolchain=value`}  
+    :sgrde:`default-version`  {:sgrva:`variant=value`} 
+
 Extra specifiers
 ----------------
 

NEWS.rst

@@ -130,6 +130,12 @@ Modules 5.3.0 (not yet released)
 * Add :option:`--ignore-user-rc` command-line switch to enable
   :mconfig:`ignore_user_rc` configuration option and ignore user-specific
   module rc file for current execution.
+* Add the ``variantifspec`` element in the allowed value list of the
+  :mconfig:`avail_output` and :mconfig:`avail_terse_output` configuration
+  options. Set this new element in the default value list of both options.
+  When set and if a variant is specified in search query, variants and their
+  possible values are reported along the module they are associated to on
+  :subcmd:`avail` command output.
 
 
 .. _5.2 release notes: