sultan commented on code in PR #845: URL: https://github.com/apache/maven/pull/845#discussion_r1020919045
########## maven-artifact/src/main/java/org/apache/maven/artifact/versioning/ComparableVersion.java: ########## @@ -41,19 +42,34 @@ * <code>1.0alpha1 => [1, 0, alpha, 1]</code></li> * <li>unlimited number of version components,</li> * <li>version components in the text can be digits or strings,</li> - * <li>strings are checked for well-known qualifiers and the qualifier ordering is used for version ordering. - * Well-known qualifiers (case insensitive) are:<ul> - * <li><code>alpha</code> or <code>a</code></li> - * <li><code>beta</code> or <code>b</code></li> - * <li><code>milestone</code> or <code>m</code></li> - * <li><code>rc</code> or <code>cr</code></li> - * <li><code>snapshot</code></li> - * <li><code>(the empty string)</code> or <code>ga</code> or <code>final</code></li> - * <li><code>sp</code></li> - * </ul> - * Unknown qualifiers are considered after known qualifiers, with lexical order (always case insensitive), - * </li> - * <li>a hyphen usually precedes a qualifier, and is always less important than something preceded with a dot.</li> + * <li> + * String qualifiers are ordered lexically, with the following exceptions: + * <ul> + * <li> 'snapshot' < '' < 'sp' </li> + * </ul> + * and alias => replacement: + * <ul> + * <li> 'a' => 'alpha' </li> + * <li> 'b' => 'beta' </li> + * <li> 'm' => 'milestone' </li> + * <li> 'cr' => 'rc' </li> + * <li> 'final' = 'ga' = 'release' => '' </li> + * </ul> + * </li> + * <li> + * Following semver rules is encouraged, and some qualifiers are discouraged: + * <ul> + * <li> The usage of 'CR' qualifier is discouraged. Use 'RC' instead. </li> + * <li> The usage of 'final', 'ga', 'release' qualifiers is discouraged. Use no qualifier instead. </li> + * <li> The usage of 'SP' qualifier is discouraged. Use version increment instead. </li> + * </ul> + * For other qualifiers, natural ordering is used: + * <ul> + * <li>alpha = a < beta = b < ea < milestone = m < preview < rc = cr < snapshot < '' = final = ga = release < sp</li> Review Comment: this is just a mere example of how the alphabetical ordering works. since this seems to be a problem, i will remove them from the doc -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@maven.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
