Debian Codegraph @

doc/source/design/extended-default.rst

raw
1 .. _extended-default:
2
3 Extended default
4 ================
5
6 Configuration
7 -------------
8
9 - introduce :mconfig:`extended_default` option name
10 - off by default in v4 as previously soft/1 was an error
11 - on by default in v5, option could even disappear
12 - set as a separate option than *advanced_version_spec*
13
14 - as it affects also basic soft/vers version specification
15 - seem easier to understand for user if concepts are distinguished
16
17 Specification
18 -------------
19
20 - Take partial version identifier and returns matches
21
22 - for soft/10.1.2.4 soft/10.1.2.3 soft/10.1.1
23 - query soft/10 returns highest among 3
24 - query soft/10.1 returns highest among 3
25 - query soft/1 returns nothing
26 - query soft/10.1.2 returns highest among soft/10.1.2.4 soft/10.1.2.3
27
28 - In situation where soft/1.1(default) soft/1.2 soft/2.1 soft/2.2
29
30 - query soft/1 returns soft/1.1
31 - query soft/2 returns soft/2.2
32
33 - Character considered as version number separator: ``.``
34
35 - list: ``.`` and ``-``
36 - ``-`` 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)
37 - not possible with ``+`` as it is used by variant specification
38
39 - Does not apply to the root part of module name
40
41 - e.g. *foo.2*
42
43 - If :mconfig:`implicit_default` is disabled
44
45 - it makes ``extended_default`` inoperative if queried version does not include a defined default
46 - even if only one modulefile matches query
47 - with situation described above query soft/1 returns soft/1.1
48 - but query soft/2 returns an error as no default is found among version 2 modulefiles
49
50 - Contexts where it could be used
51
52 - :ref:`module_version_specification_to_return_all_matching_modules`
53
54 - on specification that are processed as a wild search, ``extended_default`` has no impact
55
56 - as a wildcard character ``*`` is appended to specification
57 - affects ``avail``/``spider`` sub-commands
58
59 - :ref:`module_version_specification_to_select_one_module`
60 - :ref:`module_version_specification_to_check_compatibility`
61
62 .. vim:set tabstop=2 shiftwidth=2 expandtab autoindent: