Merge branch 'jb/midx-doc-update'
[git] / Documentation / config / versionsort.txt
1 versionsort.prereleaseSuffix (deprecated)::
2         Deprecated alias for `versionsort.suffix`.  Ignored if
3         `versionsort.suffix` is set.
4
5 versionsort.suffix::
6         Even when version sort is used in linkgit:git-tag[1], tagnames
7         with the same base version but different suffixes are still sorted
8         lexicographically, resulting e.g. in prerelease tags appearing
9         after the main release (e.g. "1.0-rc1" after "1.0").  This
10         variable can be specified to determine the sorting order of tags
11         with different suffixes.
12 +
13 By specifying a single suffix in this variable, any tagname containing
14 that suffix will appear before the corresponding main release.  E.g. if
15 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
16 "1.0".  If specified multiple times, once per suffix, then the order of
17 suffixes in the configuration will determine the sorting order of tagnames
18 with those suffixes.  E.g. if "-pre" appears before "-rc" in the
19 configuration, then all "1.0-preX" tags will be listed before any
20 "1.0-rcX" tags.  The placement of the main release tag relative to tags
21 with various suffixes can be determined by specifying the empty suffix
22 among those other suffixes.  E.g. if the suffixes "-rc", "", "-ck" and
23 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
24 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
25 "v4.8-bfsX".
26 +
27 If more than one suffixes match the same tagname, then that tagname will
28 be sorted according to the suffix which starts at the earliest position in
29 the tagname.  If more than one different matching suffixes start at
30 that earliest position, then that tagname will be sorted according to the
31 longest of those suffixes.
32 The sorting order between different suffixes is undefined if they are
33 in multiple config files.