Skip to content

Commit 33196b7

Browse files
rheniummatzbot
authored andcommitted
[ruby/openssl] ssl: improve documentation of SSLContext#options=
ruby/openssl@9120fcde6a
1 parent 09d516b commit 33196b7

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

ext/openssl/ossl_ssl.c

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -746,7 +746,10 @@ ssl_info_cb(const SSL *ssl, int where, int val)
746746
}
747747

748748
/*
749-
* Gets various OpenSSL options.
749+
* call-seq:
750+
* ctx.options -> integer
751+
*
752+
* Gets various \OpenSSL options.
750753
*/
751754
static VALUE
752755
ossl_sslctx_get_options(VALUE self)
@@ -761,7 +764,17 @@ ossl_sslctx_get_options(VALUE self)
761764
}
762765

763766
/*
764-
* Sets various OpenSSL options.
767+
* call-seq:
768+
* ctx.options = integer
769+
*
770+
* Sets various \OpenSSL options. The options are a bit field and can be
771+
* combined with the bitwise OR operator (<tt>|</tt>). Available options are
772+
* defined as constants in OpenSSL::SSL that begin with +OP_+.
773+
*
774+
* For backwards compatibility, passing +nil+ has the same effect as passing
775+
* OpenSSL::SSL::OP_ALL.
776+
*
777+
* See also man page SSL_CTX_set_options(3).
765778
*/
766779
static VALUE
767780
ossl_sslctx_set_options(VALUE self, VALUE options)

0 commit comments

Comments
 (0)