Skip to content

Commit 26d1a05

Browse files
authored
Add information about versions in README (#172)
1 parent e41d5a7 commit 26d1a05

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

README.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,25 @@ This crate contains the logic to build OpenSSL and is intended to be consumed by
44
the `openssl-sys` crate. You likely in theory aren't interacting with this too
55
much!
66

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+
826
Building OpenSSL for `windows-msvc` targets, users can choose whether to enable
927
assembly language routines, which requires [nasm](https://www.nasm.us/).
1028
The build process will automatically detect whether `nasm.exe` is installed in
@@ -14,15 +32,15 @@ the `no-asm` option will NOT be configured).
1432
You can manipulate this behavior by setting the `OPENSSL_RUST_USE_NASM` environment
1533
variable:
1634
* `1`: Force enable the assembly language routines. (panic if `nasm.exe` is not
17-
availible.)
35+
available.)
1836
* `0`: Force disable the assembly language routines even if the `nasm.exe` can be
1937
found in PATH.
2038
* not set: Let the build process automatically detect whether `nasm.exe` is
2139
installed. If found, enable. If not, disable.
2240

2341
However, this environment variable does NOT take effects on non-windows platforms.
2442

25-
# License
43+
## License
2644

2745
This project is licensed under either of
2846

0 commit comments

Comments
 (0)