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

Mismatch in function signature between doc and header file for SSL_group_to_name() #23775

Closed
romen opened this issue Mar 7, 2024 · 4 comments
Closed

Mismatch in function signature between doc and header file for SSL_group_to_name() #23775

romen opened this issue Mar 7, 2024 · 4 comments
Assignees
@nhorman
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 good first issue Bite size change that could be a good start hold: need otc decision The OTC needs to make a decision triaged: bug The issue/pr is/fixes a bug triaged: documentation The issue/pr deals with documentation (errors)

Comments

@romen
Copy link
Member

romen commented Mar 7, 2024

The documentation reports:

const char *SSL_group_to_name(const SSL *ssl, int id);

but the header includes:

openssl/include/openssl/ssl.h.in

Line 1511 in 74fd682

const char *SSL_group_to_name(SSL *s, int id);

@romen romen added the issue: documentation The issue reports errors in (or missing) documentation label Mar 7, 2024
@romen
Copy link
Member Author

romen commented Mar 7, 2024

This was noticed by @botovq in sfackler/rust-openssl#2201 (comment)

@romen romen mentioned this issue Mar 7, 2024
Open
2 tasks
@nhorman nhorman self-assigned this Mar 7, 2024
@t8m t8m added branch: master Merge to master branch triaged: bug The issue/pr is/fixes a bug triaged: documentation The issue/pr deals with documentation (errors) branch: 3.2 Merge to openssl-3.2 branch: 3.0 Merge to openssl-3.0 branch branch: 3.1 Merge to openssl-3.1 good first issue Bite size change that could be a good start and removed issue: documentation The issue reports errors in (or missing) documentation labels Mar 8, 2024
@nhorman nhorman added the hold: need otc decision The OTC needs to make a decision label Mar 8, 2024
@nhorman
Copy link
Contributor

nhorman commented Mar 8, 2024 •
edited

I think this makes sense for master, but I'm not sure we can make the corresponding change in 3.1 or 3.2 as it would constitute an API change in a stable release:
https://www.openssl.org/policies/technical/stable-release-updates.html

OTC: Can we modify a public api to qualify a type as const in a stable release

nhorman added a commit to nhorman/openssl that referenced this issue Mar 8, 2024
@nhorman
Fix SSL_group_to_name to match docs
e0a9473 
SSL_group_to_name documents the first parameter SSL as being const, but
the header files don't match that, bring them into line

Fixed openssl#23775
@nhorman nhorman mentioned this issue Mar 8, 2024
Closed
@mattcaswell
Copy link
Member

Can we modify a public api to qualify a type as const in a stable release

No, but we can change the documentation to match reality.

@nhorman
Copy link
Contributor

nhorman commented Mar 10, 2024

fixed

@nhorman nhorman closed this as completed Mar 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nhorman nhorman

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 good first issue Bite size change that could be a good start hold: need otc decision The OTC needs to make a decision triaged: bug The issue/pr is/fixes a bug triaged: documentation The issue/pr deals with documentation (errors)
Projects
Project Board
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix SSL_group_to_name docs to match api defintion nhorman/openssl
4 participants
@romen @nhorman @t8m @mattcaswell