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

doc : Corrected the return value documentation for SSL_SESSION_set_time() #24356

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

doc : Corrected the return value documentation for SSL_SESSION_set_time() #24356

wants to merge 1 commit into from

Conversation

irosay
Copy link
Contributor

@irosay irosay commented May 10, 2024 •
edited

Fixes #24322

This pull request updates the documentation of the return value for SSL_SESSION_set_time() and SSL_SESSION_set_timeout()

CLA: trivial

Checklist
  • [+] documentation is added or updated

@openssl-machine openssl-machine added the hold: cla required The contributor needs to submit a license agreement label May 10, 2024
kroeckx
kroeckx reviewed May 10, 2024
View reviewed changes
doc/man3/SSL_SESSION_get_time.pod
SSL_SESSION_set_time() and SSL_SESSION_set_timeout() return 1 on success.
SSL_SESSION_set_time() sets the time for the SSL session and returns the new time on success or 0 on error.

SSL_SESSION_set_timeout() sets the timeout value for the SSL session and returns 1 on success or 0 on error.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What the functions do is documented earlier, only the return value is documented in this section.

@t8m t8m 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 tests: exempted The PR is exempt from requirements for testing branch: 3.2 Merge to openssl-3.2 branch: 3.3 Merge to openssl-3.3 labels May 10, 2024
@irosay irosay changed the title docs: Correct documentation for SSL_SESSION_set_time() doc : Corrected the return value documentation for SSL_SESSION_set_time() May 10, 2024
@irosay irosay marked this pull request as draft May 10, 2024 13:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kroeckx kroeckx kroeckx left review comments

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 hold: cla required The contributor needs to submit a license agreement tests: exempted The PR is exempt from requirements for testing triaged: documentation The issue/pr deals with documentation (errors)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

SSL_SESSION_set_time incorrect documentation
4 participants
@irosay @kroeckx @t8m @openssl-machine