Commit 3a63dbef authored by Richard Levitte's avatar Richard Levitte
Browse files

Switch to MAJOR.MINOR.PATCH versioning and version 3.0.0-dev 



We're strictly use version numbers of the form MAJOR.MINOR.PATCH.
Letter releases are things of days past.

The most central change is that we now express the version number with
three macros, one for each part of the version number:

    OPENSSL_VERSION_MAJOR
    OPENSSL_VERSION_MINOR
    OPENSSL_VERSION_PATCH

We also provide two additional macros to express pre-release and build
metadata information (also specified in semantic versioning):

    OPENSSL_VERSION_PRE_RELEASE
    OPENSSL_VERSION_BUILD_METADATA

To get the library's idea of all those values, we introduce the
following functions:

    unsigned int OPENSSL_version_major(void);
    unsigned int OPENSSL_version_minor(void);
    unsigned int OPENSSL_version_patch(void);
    const char *OPENSSL_version_pre_release(void);
    const char *OPENSSL_version_build_metadata(void);

Additionally, for shared library versioning (which is out of scope in
semantic versioning, but that we still need):

    OPENSSL_SHLIB_VERSION

We also provide a macro that contains the release date.  This is not
part of the version number, but is extra information that we want to
be able to display:

    OPENSSL_RELEASE_DATE

Finally, also provide the following convenience functions:

    const char *OPENSSL_version_text(void);
    const char *OPENSSL_version_text_full(void);

The following macros and functions are deprecated, and while currently
existing for backward compatibility, they are expected to disappear:

    OPENSSL_VERSION_NUMBER
    OPENSSL_VERSION_TEXT
    OPENSSL_VERSION
    OpenSSL_version_num()
    OpenSSL_version()

Also, this function is introduced to replace OpenSSL_version() for all
indexes except for OPENSSL_VERSION:

    OPENSSL_info()

For configuration, the option 'newversion-only' is added to disable all
the macros and functions that are mentioned as deprecated above.

Reviewed-by: default avatarTim Hudson <tjh@openssl.org>
Reviewed-by: default avatarMatthias St. Pierre <Matthias.St.Pierre@ncp-e.com>
Reviewed-by: default avatarMatt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/7724)
parent 672f943a

CHANGES

+13 −1
Original line number Diff line number Diff line
@@ -7,7 +7,19 @@ 
 https://github.com/openssl/openssl/commits/ and pick the appropriate

 release branch.













 Changes between 1.1.1 and 1.1.2 [xx XXX xxxx]













 Changes between 1.1.1 and 3.0.0 [xx XXX xxxx]

























  *) Switch to a new version scheme using three numbers MAJOR.MINOR.PATCH.

























     o Major releases (indicated by incrementing the MAJOR release number)













       may introduce incompatible API/ABI changes.













     o Minor releases (indicated by incrementing the MINOR release number)













       may introduce new features but retain API/ABI compatibility.













     o Patch releases (indicated by incrementing the PATCH number)













       are intended for bug fixes and other improvements of existing













       features only (like improving performance or adding documentation)













       and retain API/ABI compatibility.













     [Richard Levitte]





























  *) Remove the 'dist' target and add a tarball building script.  The















     'dist' target has fallen out of use, and it shouldn't be

































Configurations/descrip.mms.tmpl



+2
−5






























Original line number
Diff line number
Diff line








@@ -104,13 +104,10 @@ BLDDIR={- $config{builddir} -}













# to testing.















VERBOSE=$(V)





























VERSION={- $config{version} -}













VERSION={- "$config{major}.$config{minor}.$config{patch}$config{prerelease}$config{build_metadata}" -}















MAJOR={- $config{major} -}















MINOR={- $config{minor} -}













SHLIB_VERSION_NUMBER={- $config{shlib_version_number} -}













SHLIB_VERSION_HISTORY={- $config{shlib_version_history} -}













SHLIB_MAJOR={- $config{shlib_major} -}













SHLIB_MINOR={- $config{shlib_minor} -}













SHLIB_VERSION_NUMBER={- $config{shlib_version} -}















SHLIB_TARGET={- $target{shared_target} -}































EXE_EXT=.EXE

































Configurations/unix-Makefile.tmpl



+2
−5






























Original line number
Diff line number
Diff line








@@ -88,13 +88,10 @@ CONFIGURE_ARGS=({- join(", ",quotify_l(@{$config{perlargv}})) -})













SRCDIR={- $config{sourcedir} -}















BLDDIR={- $config{builddir} -}





























VERSION={- $config{version} -}













VERSION={- "$config{major}.$config{minor}.$config{patch}$config{prerelease}$config{build_metadata}" -}















MAJOR={- $config{major} -}















MINOR={- $config{minor} -}













SHLIB_VERSION_NUMBER={- $config{shlib_version_number} -}













SHLIB_VERSION_HISTORY={- $config{shlib_version_history} -}













SHLIB_MAJOR={- $config{shlib_major} -}













SHLIB_MINOR={- $config{shlib_minor} -}













SHLIB_VERSION_NUMBER={- $config{shlib_version} -}















SHLIB_TARGET={- $target{shared_target} -}















SHLIB_EXT={- $shlibext -}















SHLIB_EXT_SIMPLE={- $shlibextsimple -}

































Configurations/windows-makefile.tmpl



+2
−2






























Original line number
Diff line number
Diff line








@@ -71,11 +71,11 @@ PLATFORM={- $config{target} -}













SRCDIR={- $config{sourcedir} -}















BLDDIR={- $config{builddir} -}





























VERSION={- $config{version} -}













VERSION={- "$config{major}.$config{minor}.$config{patch}$config{prerelease}$config{build_metadata}" -}















MAJOR={- $config{major} -}















MINOR={- $config{minor} -}





























SHLIB_VERSION_NUMBER={- $config{shlib_version_number} -}













SHLIB_VERSION_NUMBER={- $config{shlib_version} -}































LIBS={- join(" ", map { ( shlib_import($_), lib($_) ) } @{$unified_info{libraries}}) -}















SHLIBS={- join(" ", map { shlib($_) } @{$unified_info{libraries}}) -}

































Configure



+23
−17






























Original line number
Diff line number
Diff line








@@ -242,28 +242,34 @@ if (grep /^reconf(igure)?$/, @argvcopy) {













$config{perlargv} = [ @argvcopy ];































# Collect version numbers













$config{version} = "unknown";













$config{version_num} = "unknown";













$config{shlib_version_number} = "unknown";













$config{shlib_version_history} = "unknown";













$config{major} = "unknown";













$config{minor} = "unknown";













$config{patch} = "unknown";













$config{prerelease} = "";













$config{build_metadata} = "";













$config{shlib_version} = "unknown";































collect_information(















    collect_from_file(catfile($srcdir,'include/openssl/opensslv.h')),













    qr/OPENSSL.VERSION.TEXT.*OpenSSL (\S+) / => sub { $config{version} = $1; },













    qr/OPENSSL.VERSION.NUMBER.*(0x\S+)/	     => sub { $config{version_num}=$1 },













    qr/SHLIB_VERSION_NUMBER *"([^"]+)"/	     => sub { $config{shlib_version_number}=$1 },













    qr/SHLIB_VERSION_HISTORY *"([^"]*)"/     => sub { $config{shlib_version_history}=$1 }













    qr/#\s+define\s+OPENSSL_VERSION_MAJOR\s+(\d+)/ =>













        sub { $config{major} = $1; },













    qr/#\s+define\s+OPENSSL_VERSION_MINOR\s+(\d+)/ =>













        sub { $config{minor} = $1; },













    qr/#\s+define\s+OPENSSL_VERSION_PATCH\s+(\d+)/ =>













        sub { $config{patch} = $1; },













    qr/#\s+define\s+OPENSSL_VERSION_PRE_RELEASE\s+"((?:\\.|[^"])*)"/ =>













        sub { $config{prerelease} = $1; },













    qr/#\s+define\s+OPENSSL_VERSION_BUILD_METADATA\s+"((?:\\.|[^"])*)"/ =>













        sub { $config{build_metadata} = $1; },













    qr/#\s+define\s+OPENSSL_SHLIB_VERSION\s+([\d\.]+)/ =>













        sub { $config{shlib_version} = $1; },















    );













if ($config{shlib_version_history} ne "") { $config{shlib_version_history} .= ":"; }



























($config{major}, $config{minor})













    = ($config{version} =~ /^([0-9]+)\.([0-9\.]+)/);













($config{shlib_major}, $config{shlib_minor})













    = ($config{shlib_version_number} =~ /^([0-9]+)\.([0-9\.]+)/);















die "erroneous version information in opensslv.h: ",













    "$config{major}, $config{minor}, $config{shlib_major}, $config{shlib_minor}\n"













    if ($config{major} eq "" || $config{minor} eq ""













	|| $config{shlib_major} eq "" ||  $config{shlib_minor} eq "");













    "$config{major}.$config{minor}.$config{patch}, $config{shlib_version}\n"













    if ($config{major} eq "unknown"













            || $config{minor} eq "unknown"













            || $config{patch} eq "unknown"













            || $config{shlib_version} eq "unknown");































# Collect target configurations