doc: update add-property to define tag with "value" arg

Signed-off-by: Xavier Delaruelle <[email protected]>

Author: xdelaruelle

NEWS.rst

@@ -112,6 +112,8 @@ Modules 5.6.0 (not yet released)
   version of Modules within :file:`siteconfig.tcl` script.
 * Introduce :mfcmd:`module-help` modulefile command which defines help text to
   print when modulefile is evaluated in ``help`` mode.
+* Update :mfcmd:`add-property` modulefile command to use its *value* argument
+  to define tag on currently loading module.
 
 .. _Security policy: https://github.com/envmodules/modules/blob/main/SECURITY.md
 .. _Modules chat room: https://matrix.to/#/#modules:matrix.org

doc/source/design/lmod-tcl-modulefile-compat.rst

@@ -41,16 +41,27 @@ Lmod Tcl modulefile compatibility
   - Could be unset with ``remove-property``
   - Defined as a key-value
 
-- These commands will be first implemented as a no-operation command (``nop``)
+- As of Modules version 5.1, these commands are implemented as a no-operation
+  command (``nop``)
 
   - No error raised if used
   - And no warning message to avoid polluting output
 
 - These commands are intended for use only within modulefile evaluation
   context (not within modulerc)
 
-- *FUTURE*: it could be interesting to map some properties on tags like the
-  ``lmod:sticky`` property which corresponds to the ``sticky`` tag
+- An update is made on Modules version 5.6: argument *value* of
+  mfcmd:`add-property` is converted to :mfcmd:`module-tag` onto loading
+  modulefile
+
+  - Argument *name* is ignored as it seems *value* is the deterministic
+    information (can be understood just by itself)
+  - Argument *value* is split as sometimes multiple values are aggregated with
+    ``:`` separator
+  - ``remove-property`` stays as a no-op operation as Modules does not have
+    a tag-withdrawn mechanism (and it does not seem useful)
+  - ``add-property`` is no-op during scan evaluation mode as module tags
+    search does not currently trigger an extra match search
 
 
 ``extensions``

doc/source/modulefile.rst

@@ -66,6 +66,16 @@ the Module commands return the empty string. Some commands behave differently
 when a *modulefile* is loaded or unloaded. The command descriptions assume
 the *modulefile* is being loaded.
 
+.. mfcmd:: add-property name value
+
+ Associate module tag *value* to currently loading *modulefile*. Argument
+ *name* is ignored. See :mfcmd:`module-tag` command for more information on
+ tags.
+
+ .. only:: html
+
+    .. versionadded:: 5.6
+
 .. mfcmd:: always-load [options] modulefile...
 
  Load *modulefile* and apply the ``keep-loaded`` tag to it in order to avoid