Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix LIBRESSL_VERSION_NUMBER document mistake. #667

Merged
merged 1 commit into from
Aug 24, 2023

Conversation

junaruga
Copy link
Member

@junaruga junaruga commented Aug 22, 2023

This PR improves and fixes typo created by the PR #662. Sorry! I checked the generated rdoc on local.

Note that here is the actual man content.

$ man -M /home/jaruga/.local/libressl-6650dce/share/man/ 3 LIBRESSL_VERSION_NUMBER
...
DESCRIPTION
     OPENSSL_VERSION_NUMBER and LIBRESSL_VERSION_NUMBER are numeric release version
     identifiers.  The first two digits contain the major release number, the third and
     fourth digits the minor release number, and the fifth and sixth digits the fix re‐
     lease number.  For OpenSSL, the seventh and eight digits contain the patch release
     number and the final digit is 0 for development, 1 to e for betas 1 to 14, or f
     for release.  For LibreSSL, OPENSSL_VERSION_NUMBER is always 0x020000000, and
     LIBRESSL_VERSION_NUMBER always ends with 00f.
...
     LIBRESSL_VERSION_NUMBER first appeared in LibreSSL 2.0.0 and OpenBSD 5.6 and got
     its final format in LibreSSL 2.3.2 and OpenBSD 5.9.  LIBRESSL_VERSION_TEXT first
     appeared in LibreSSL 2.2.2 and OpenBSD 5.8.

  • Fix the wrong man reference.
  • According to the LIBRESSL_VERSION_NUMBER(3), the value always ends with 00f.

* Fix the wrong man reference.
* According to the LIBRESSL_VERSION_NUMBER(3), the value always ends with 00f.

```
$ man -M /home/jaruga/.local/libressl-6650dce/share/man/ 3 LIBRESSL_VERSION_NUMBER
...
DESCRIPTION
     OPENSSL_VERSION_NUMBER and LIBRESSL_VERSION_NUMBER are numeric release version
     identifiers.  The first two digits contain the major release number, the third and
     fourth digits the minor release number, and the fifth and sixth digits the fix re‐
     lease number.  For OpenSSL, the seventh and eight digits contain the patch release
     number and the final digit is 0 for development, 1 to e for betas 1 to 14, or f
     for release.  For LibreSSL, OPENSSL_VERSION_NUMBER is always 0x020000000, and
     LIBRESSL_VERSION_NUMBER always ends with 00f.
```
@rhenium rhenium merged commit fe7612f into ruby:master Aug 24, 2023
43 checks passed
@junaruga junaruga deleted the wip/doc-LIBRESSL_VERSION_NUMBER branch August 24, 2023 16:57
@junaruga
Copy link
Member Author

Thanks for reviewing!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants