SSL verify_fun documentation is incorrect

Roger Lipscombe <[email protected]> Fri, 21 Feb 2014 16:43:42 +0000
Newsgroups gmane.comp.lang.erlang.patches
Message-ID <CAJgnQd8G1LXAM_WQ_Q136j67G+2hxqnVerj_emkAgH5uJgH2eg@mail.gmail.com>
In http://www.erlang.org/doc/man/ssl.html, the spec for Event is
missing the valid and valid_peer options. These are documented (sorta)
further down in the page, but the spec is missing them.

I _believe_ that this is the correct patch:

diff --git a/lib/ssl/doc/src/ssl.xml b/lib/ssl/doc/src/ssl.xml
index 80ef419..4513ecd 100644
--- a/lib/ssl/doc/src/ssl.xml
+++ b/lib/ssl/doc/src/ssl.xml
@@ -233,7 +233,7 @@

        <code>
 fun(OtpCert :: #'OTPCertificate'{}, Event :: {bad_cert, Reason :: atom()} |
-            {extension, #'Extension'{}}, InitialUserState :: term()) ->
+            {extension, #'Extension'{}} | valid | valid_peer,
InitialUserState :: term()) ->
        {valid, UserState :: term()} | {valid_peer, UserState :: term()} |
        {fail, Reason :: term()} | {unknown, UserState :: term()}.
        </code>

Regards,
Roger.
_______________________________________________
erlang-patches mailing list
[email protected]
http://erlang.org/mailman/listinfo/erlang-patches