]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
Update NOTES-WINDOWS.md
authorNeil Horman <nhorman@openssl.org>
Wed, 26 Jun 2024 15:50:46 +0000 (11:50 -0400)
committerNeil Horman <nhorman@openssl.org>
Tue, 9 Jul 2024 08:01:44 +0000 (04:01 -0400)
The behavior of windows with registry keys is somewhat confusing, and
based on both build time defines, and reg key availablility.  Add a
table defining behavior in all cases

Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/24450)

NOTES-WINDOWS.md

index cd8fdfb3f0d1dbe03546066eaf2019f327efe50d..f7984cda0c1256cd4c062019d6fb991fa9708030 100644 (file)
@@ -99,7 +99,7 @@ check the INSTALL.md file.
 Installation directories
 ------------------------
 
-On most Unix platform installation directories are determined at build time via
+On most Unix platforms installation directories are determined at build time via
 constant defines.  On Windows platforms however, installation directories are
 determined via registry keys, as it is common practice to build OpenSSL and
 install it to a variety of locations.
@@ -119,7 +119,7 @@ at build-time to construct library build specific registry key paths of the
 format:
 `\\HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432node\OpenSSL-<version>-<ctx>`
 
-Where `<version>` is the semantic major.minor.patch version of the library being
+Where `<version>` is the major.minor version of the library being
 built, and `<ctx>` is the value specified by `-DOPENSSL_WINCTX`.  This allows
 for multiple openssl builds to be created and installed on a single system, in
 which each library can use its own set of registry keys.
@@ -127,9 +127,15 @@ which each library can use its own set of registry keys.
 Note the installer available at <https://github.com/openssl/installer> will set
 these keys when the installer is run.
 
-If the registry keys above do not exist on a given system, or if the
-`OSSL_WINCTX` variable is not defined at build time, OpenSSL makes no attempt to
-load configuration, engines of modules from disk.
+A summary table of behavior on Windows platforms
+
+|`OSSL_WINCTX`|Registry key|OpenSSL Behavior                          |
+|-------------|------------|------------------------------------------|
+|Defined      | Defined    |OpenSSL Reads Paths from Registry         |
+|Defined      | Undefined  |OpenSSL returns errors on module/conf load| 
+|Undefined    | N/A        |OpenSSL uses build time defaults          |
+
+
 
 Special notes for Universal Windows Platform builds, aka `VC-*-UWP`
 -------------------------------------------------------------------