Skip to content

Commit

Permalink
Add documentation for the function SSL_CONF_CTX_finish.
Browse files Browse the repository at this point in the history
Add documentation for the function SSL_CONF_CTX_finish() in man3.

Fixes #22084

Signed-off-by: Sumitra Sharma <sumitraartsy@gmail.com>

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from #22128)
  • Loading branch information
heygauri authored and paulidale committed Sep 20, 2023
1 parent e900942 commit 955c133
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
8 changes: 8 additions & 0 deletions doc/man3/SSL_CONF_CTX_set_ssl_ctx.pod
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

=head1 NAME

SSL_CONF_CTX_finish,
SSL_CONF_CTX_set_ssl_ctx, SSL_CONF_CTX_set_ssl - set context to configure

=head1 SYNOPSIS
Expand All @@ -10,6 +11,7 @@ SSL_CONF_CTX_set_ssl_ctx, SSL_CONF_CTX_set_ssl - set context to configure

void SSL_CONF_CTX_set_ssl_ctx(SSL_CONF_CTX *cctx, SSL_CTX *ctx);
void SSL_CONF_CTX_set_ssl(SSL_CONF_CTX *cctx, SSL *ssl);
int SSL_CONF_CTX_finish(SSL_CONF_CTX *cctx);

=head1 DESCRIPTION

Expand All @@ -23,6 +25,10 @@ B<SSL> structure B<ssl>. Any previous B<SSL> or B<SSL_CTX> associated with
B<cctx> is cleared. Subsequent calls to SSL_CONF_cmd() will be sent to
B<ssl>.

The function SSL_CONF_CTX_finish() must be called after all configuration
operations have been completed. It is used to finalise any operations
or to process defaults.

=head1 NOTES

The context need not be set or it can be set to B<NULL> in which case only
Expand All @@ -32,6 +38,8 @@ syntax checking of commands is performed, where possible.

SSL_CONF_CTX_set_ssl_ctx() and SSL_CTX_set_ssl() do not return a value.

SSL_CONF_CTX_finish() returns 1 for success and 0 for failure.

=head1 SEE ALSO

L<ssl(7)>,
Expand Down
1 change: 0 additions & 1 deletion util/missingssl.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ ERR_load_SSL_strings(3)
SRP_Calc_A_param(3)
SSL_COMP_get_name(3)
SSL_COMP_set0_compression_methods(3)
SSL_CONF_CTX_finish(3)
SSL_CTX_SRP_CTX_free(3)
SSL_CTX_SRP_CTX_init(3)
SSL_CTX_get0_certificate(3)
Expand Down

0 comments on commit 955c133

Please sign in to comment.