Skip to content

Commit 9120fcd

Browse files
committed
ssl: improve documentation of SSLContext#options=
1 parent ade5076 commit 9120fcd

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
@@ -757,7 +757,10 @@ ssl_info_cb(const SSL *ssl, int where, int val)
757757
}
758758

759759
/*
760-
* Gets various OpenSSL options.
760+
* call-seq:
761+
* ctx.options -> integer
762+
*
763+
* Gets various \OpenSSL options.
761764
*/
762765
static VALUE
763766
ossl_sslctx_get_options(VALUE self)
@@ -772,7 +775,17 @@ ossl_sslctx_get_options(VALUE self)
772775
}
773776

774777
/*
775-
* Sets various OpenSSL options.
778+
* call-seq:
779+
* ctx.options = integer
780+
*
781+
* Sets various \OpenSSL options. The options are a bit field and can be
782+
* combined with the bitwise OR operator (<tt>|</tt>). Available options are
783+
* defined as constants in OpenSSL::SSL that begin with +OP_+.
784+
*
785+
* For backwards compatibility, passing +nil+ has the same effect as passing
786+
* OpenSSL::SSL::OP_ALL.
787+
*
788+
* See also man page SSL_CTX_set_options(3).
776789
*/
777790
static VALUE
778791
ossl_sslctx_set_options(VALUE self, VALUE options)

0 commit comments

Comments
 (0)