@@ -4,7 +4,25 @@ This crate contains the logic to build OpenSSL and is intended to be consumed by
4
4
the ` openssl-sys ` crate. You likely in theory aren't interacting with this too
5
5
much!
6
6
7
- ### Windows MSVC Assembly
7
+ ## Versioning
8
+
9
+ There are currently two maintained branches, matching the
10
+ two [ maintained OpenSSL versions] ( https://www.openssl.org/policies/releasestrat.html ) :
11
+ * ` main ` which builds OpenSSL 3.0
12
+ * ` release/111 ` which builds OpenSSL 1.1.1
13
+
14
+ The crates versions follow the ` X.Y.Z+B ` pattern:
15
+ * The major version ` X ` is the upstream OpenSSL version:
16
+ * ` 111 ` for 1.1.1
17
+ * ` 300 ` for 3.0 (to be higher than ` 111 ` )
18
+ * The minor ` Y ` and patch ` Z ` versions are incremented when making changes
19
+ to the crate, either OpenSSL update or internal changes.
20
+ * ` B ` contains the full upstream OpenSSL version, like ` 1.1.1k ` or ` 3.0.7 ` .
21
+ Note that this field is actually ignored in comparisons and only there for
22
+ documentation.
23
+
24
+ ## Windows MSVC Assembly
25
+
8
26
Building OpenSSL for ` windows-msvc ` targets, users can choose whether to enable
9
27
assembly language routines, which requires [ nasm] ( https://www.nasm.us/ ) .
10
28
The build process will automatically detect whether ` nasm.exe ` is installed in
@@ -14,15 +32,15 @@ the `no-asm` option will NOT be configured).
14
32
You can manipulate this behavior by setting the ` OPENSSL_RUST_USE_NASM ` environment
15
33
variable:
16
34
* ` 1 ` : Force enable the assembly language routines. (panic if ` nasm.exe ` is not
17
- availible .)
35
+ available .)
18
36
* ` 0 ` : Force disable the assembly language routines even if the ` nasm.exe ` can be
19
37
found in PATH.
20
38
* not set: Let the build process automatically detect whether ` nasm.exe ` is
21
39
installed. If found, enable. If not, disable.
22
40
23
41
However, this environment variable does NOT take effects on non-windows platforms.
24
42
25
- # License
43
+ ## License
26
44
27
45
This project is licensed under either of
28
46
0 commit comments