Switch to MAJOR.MINOR.PATCH versioning and version 3.0.0-dev
authorRichard Levitte <levitte@openssl.org>
Thu, 27 Sep 2018 13:56:35 +0000 (15:56 +0200)
committerRichard Levitte <levitte@openssl.org>
Thu, 6 Dec 2018 11:24:47 +0000 (12:24 +0100)
commit3a63dbef15b62b121c5df8762f8cb915fb06b27a
tree5408ad7c75146d2a70da69adf99c395f5fa67c19
parent672f943ad6c6d16b1f65a77b8e2c83c8f44a112b
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: Tim Hudson <tjh@openssl.org>
Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/7724)
30 files changed:
CHANGES
Configurations/descrip.mms.tmpl
Configurations/unix-Makefile.tmpl
Configurations/windows-makefile.tmpl
Configure
NEWS
README
VMS/openssl_shutdown.com.in
VMS/openssl_startup.com.in
apps/speed.c
apps/version.c
build.info
crypto/cversion.c
doc/man3/EVP_PKEY_supports_digest_nid.pod
doc/man3/OPENSSL_VERSION_NUMBER.pod [deleted file]
doc/man3/OpenSSL_version.pod [new file with mode: 0644]
engines/e_padlock.c
include/openssl/crypto.h
include/openssl/opensslconf.h.in
include/openssl/opensslv.h
test/recipes/80-test_cipherlist.t
test/recipes/90-test_shlibload.t
test/shlibloadtest.c
test/versions.c
util/libcrypto.num
util/mkdef.pl
util/mkrc.pl
util/perl/OpenSSL/Ordinals.pm
util/perl/OpenSSL/Test.pm
util/private.num