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.

Sign up for GitHub

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

Jump to bottom

SSL_SESSION_set_time incorrect documentation #24322

Open
ctz opened this issue May 2, 2024 · 1 comment · May be fixed by #24356
Open

SSL_SESSION_set_time incorrect documentation #24322

ctz opened this issue May 2, 2024 · 1 comment · May be fixed by #24356
Labels
branch: master Merge to master branch branch: 3.0 Merge to openssl-3.0 branch branch: 3.1 Merge to openssl-3.1 branch: 3.2 Merge to openssl-3.2 branch: 3.3 Merge to openssl-3.3 good first issue Bite size change that could be a good start help wanted triaged: documentation The issue/pr deals with documentation (errors)

Comments

@ctz
Copy link
Contributor

ctz commented May 2, 2024

Version: main at time of writing.

Of SSL_SESSION_set_time, the docs say:

openssl/doc/man3/SSL_SESSION_get_time.pod

Line 63 in 067fbc0

SSL_SESSION_set_time() and SSL_SESSION_set_timeout() return 1 on success.

This is not correct: SSL_SESSION_set_time returns the new time, or 0 on error.
@ctz ctz added the issue: documentation The issue reports errors in (or missing) documentation label May 2, 2024
@mattcaswell mattcaswell added branch: master Merge to master branch triaged: documentation The issue/pr deals with documentation (errors) branch: 3.0 Merge to openssl-3.0 branch branch: 3.1 Merge to openssl-3.1 branch: 3.2 Merge to openssl-3.2 branch: 3.3 Merge to openssl-3.3 good first issue Bite size change that could be a good start help wanted and removed issue: documentation The issue reports errors in (or missing) documentation labels May 2, 2024
@mattcaswell
Copy link
Member

Agreed, this looks incorrect. Adding good first issue and help wanted labels.

@irosay irosay linked a pull request May 10, 2024 that will close this issue
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
branch: master Merge to master branch branch: 3.0 Merge to openssl-3.0 branch branch: 3.1 Merge to openssl-3.1 branch: 3.2 Merge to openssl-3.2 branch: 3.3 Merge to openssl-3.3 good first issue Bite size change that could be a good start help wanted triaged: documentation The issue/pr deals with documentation (errors)
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc : Corrected the return value documentation for SSL_SESSION_set_time() irosay/openssl
2 participants
@ctz @mattcaswell