From: Richard Levitte <levitte@openssl.org>
Date: Tue, 15 Oct 2024 10:47:37 +0000 (+0200)
Subject: [DOC] Document the OPENSSL_WINCTX type for OpenSSL_version()
X-Git-Tag: openssl-3.5.0-alpha1~1002
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=0f8ff8fc25340205cdd5b724f3e414bdf931e8bb;p=thirdparty%2Fopenssl.git

[DOC] Document the OPENSSL_WINCTX type for OpenSSL_version()

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Tom Cosgrove <tom.cosgrove@arm.com>
(Merged from https://github.com/openssl/openssl/pull/25693)
---

diff --git a/doc/man3/OpenSSL_version.pod b/doc/man3/OpenSSL_version.pod
index 8227c785006..e5dff33dcdd 100644
--- a/doc/man3/OpenSSL_version.pod
+++ b/doc/man3/OpenSSL_version.pod
@@ -162,6 +162,15 @@ The value has the same syntax as the environment variable.
 For x86 the string looks like C<CPUINFO: OPENSSL_ia32cap=0x123:0x456>
 or C<CPUINFO: N/A> if not available.
 
+=item OPENSSL_WINCTX
+
+The Windows install context.
+The Windows install context is used to compute the OpenSSL registry key name
+on Windows.  The full registry key is
+C<SOFTWARE\WOW6432Node\OpenSSL-{major}.{minor}-{context}>, where C<{major}>,
+C<{minor}> and C<{context}> are OpenSSL's major version number, minor version
+number and the Windows install context, respectively.
+
 =back
 
 For an unknown I<t>, the text C<not available> is returned.