From 225f2a399bd6f51f0bf6d07d3a486c55c5ed82ad Mon Sep 17 00:00:00 2001 From: dsiders Date: Sun, 25 Jun 2023 21:04:23 +0100 Subject: [PATCH] Docs: Updates version and release number topics for changes in 3.0. --- docs/xml/lazutils/lazversion.xml | 62 +++++++++++++++++++++++++++++--- docs/xml/lcl/lclversion.xml | 18 ++++++++-- 2 files changed, 72 insertions(+), 8 deletions(-) diff --git a/docs/xml/lazutils/lazversion.xml b/docs/xml/lazutils/lazversion.xml index b78be21f06..ce9b282e5b 100644 --- a/docs/xml/lazutils/lazversion.xml +++ b/docs/xml/lazutils/lazversion.xml @@ -17,6 +17,20 @@ Values in the unit are used as the basis for corresponding LCL version numbers in the lclversion.pas unit.

+Please note that version numbers used for Lazarus, and the LCL and LazUtils +libraries were changed starting with version 3.0. The release part of the +version number is no longer used. Only the major and minor values are +significant. The release number will always be 0 (zero) starting with version +3.0. +

+

+In addition, odd minor version numbers no longer indicate that it is a +development (or trunk) version. Minor version numbers will be incremented with +each subsequent release or fixes branch: 3.0, 3.1, 3.2, ad ininitum. +Development versions are always represented as minor version number 99; i.e. +3.99 is the development branch for the version 3.X family. +

+

lazversion.pas is part of the lazutils package.

@@ -26,9 +40,10 @@ numbers in the lclversion.pas unit. Type used for the OnLCLWidgetTypeName function variable. - -Used in the GetLCLWidgetTypeName routine to get the name for the widgetset on the current platform. - +

+Used in the GetLCLWidgetTypeName routine to get the name for the widgetset on +the current platform. +

 @@ -40,7 +55,9 @@ Used in the GetLCLWidgetTypeName routine to get the name for the widgetset on th Major version number for the Lazarus IDE. +

For the Lazarus version number 2.3.0.42, the value in laz_major is 2. +

 @@ -51,41 +68,74 @@ Added in revision 57504, and available since Lazarus 1.8.4. Minor version number for the Lazarus IDE. +

For the Lazarus version number 2.3.0.42, the value in laz_minor is 3. +

+

+Please note: Starting with Lazarus version 3.0, laz_minor is +incremented by 1 for each new release or fixes branch. For example: 3.0, 3.1, +3.2, ad infinitum. In addition, odd minor version numbers no longer indicate +that they are a development (or trunk) version. The development branch is +always represented as minor version number 99; i.e. 3.99 is the development +branch for the 3.X family. +

 +

Added in revision 57504, and available since Lazarus 1.8.4. +

+

+Usage context modified in Lazarus version 3.0. +

 Release number for the Lazarus IDE. +

For the Lazarus version number 2.3.0.42, the value in laz_release is 0. +

+

+Please note: Starting with Lazarus 3.0, the release number is no longer +used and will always contain 0 (zero). Releases are represented using the +major and minor version numbers: 3.0, 3.1, 3.2, ad infinitum. +

 +

Added in revision 57504, and available since Lazarus 1.8.4. +

+

+No longer maintained starting with Lazarus 3.0. +

 Patch level for the Lazarus IDE. +

For the Lazarus version number 2.3.0.42, the value in laz_patch is 42. +

 +

Added in revision 57504, and available since Lazarus 1.8.4. +

 Numeric version number for the Lazarus IDE. +

For the Lazarus version number 2.3.0.42, the value in laz_fullversion is 2030042. +

 @@ -96,8 +146,10 @@ Added in revision 57504, and available since Lazarus 1.8.4. String with the full version number for the Lazarus IDE. -For the Lazarus version number 2.3.0.42, the value in laz_version is -'2.3.0.42'. +

+For the Lazarus version number 3.0.0.3, the value in laz_version is +'3.0.0.3'. +

 diff --git a/docs/xml/lcl/lclversion.xml b/docs/xml/lcl/lclversion.xml index 295d3c0777..109d8306e3 100644 --- a/docs/xml/lcl/lclversion.xml +++ b/docs/xml/lcl/lclversion.xml @@ -7,10 +7,10 @@ LCLVersion ==================================================================== --> -Contains the version number constants of the LCL. +Contains the version number constants for the LCL.

-lclversion.pas contains the version number constants of the LCL. +lclversion.pas contains the version number constants for the LCL. They can be used at run-time to determine the LCL version, so LCL application writers and component writers can offer different functionality or workarounds for bugs and take the LCL version into account while choosing their algorithms @@ -55,6 +55,13 @@ contains the first number (2). Given a version string like 2.2.4, the lcl_minor constant contains the second number (2).

+

+Please note: Starting with LCL version 3.0, lcl_minor is incremented by +1 for each new release. For example: 3.0, 3.1, 3.2, ad infinitum. In addition, +odd minor version numbers no longer indicate that they are a development (or +trunk) version. The development branch is always represented as minor version +number 99; i.e. 3.99 is the development branch for the 3.X family. +

 lcl_version @@ -66,6 +73,11 @@ contains the second number (2). Given a version string like 2.2.4, the lcl_release constant contains the third number (4).

+

+Please note: Starting with LCL 3.0, the release number is no longer +used and will always contain 0 (zero). Releases are represented using the +major and minor version numbers: 3.0, 3.1, 3.2, ad infinitum. +

lcl_version @@ -84,7 +96,7 @@ the version string is 2.2.4, then lcl_patch is 0. LCL version string. -Contains the LCL version string, e.g. 2.2.4. +Contains the LCL version string, e.g. 3.0.0.3