Skip to content

Commit

Permalink
doc: add a reference to the list of OpenSSL flags.
Browse files Browse the repository at this point in the history
Some of the SSL_OP_* constants are missing description in the
documentation. Instead of rewriting the description from OpenSSL's
wiki, I have decided to put a link to a detailed list in the
'OpenSSL Options' section.

I see no point of doing both - adding a reference to the wiki and
adding constant descriptions - but I might do if presented with
convincing arguments.

This is a follow-up to #33929.

PR-URL: #34050
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
mkrawczuk authored and addaleax committed Sep 22, 2020
1 parent 4ac0df9 commit 8960a63
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions doc/api/crypto.md
Original file line number Diff line number Diff line change
Expand Up @@ -3358,6 +3358,8 @@ the `crypto`, `tls`, and `https` modules and are generally specific to OpenSSL.

### Other OpenSSL constants

See the [list of SSL OP Flags][] for details.

<table>
<tr>
<th>Constant</th>
Expand Down Expand Up @@ -3525,3 +3527,4 @@ the `crypto`, `tls`, and `https` modules and are generally specific to OpenSSL.
[scrypt]: https://en.wikipedia.org/wiki/Scrypt
[stream-writable-write]: stream.html#stream_writable_write_chunk_encoding_callback
[stream]: stream.html
[list of SSL OP Flags]: wiki.openssl.org/index.php/List_of_SSL_OP_Flags#Table_of_Options

0 comments on commit 8960a63

Please sign in to comment.