From: Eli Zaretskii <eliz@gnu.org>
Date: Tue, 9 May 2017 19:04:45 +0000 (+0300)
Subject: Improve documentation of 'gnutls-verify-error'
X-Git-Tag: emacs-26.0.90~521^2~126^2
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=eaa00584ceb;p=emacs.git

Improve documentation of 'gnutls-verify-error'

* lisp/net/gnutls.el (gnutls-verify-error): Improve and expand
doc string.  (Bug#26845)
---

diff --git a/lisp/net/gnutls.el b/lisp/net/gnutls.el
index 02b5895e581..7e7521d877b 100644
--- a/lisp/net/gnutls.el
+++ b/lisp/net/gnutls.el
@@ -52,7 +52,27 @@ set this variable to \"normal:-dhe-rsa\"."
                  string))
 
 (defcustom gnutls-verify-error nil
-  "If non-nil, this should be a list of checks per hostname regex or t."
+  "If non-nil, this should be t or a list of checks per hostname regex.
+If nil, the default, failures in certificate verification will be
+logged (subject to `gnutls-log-level'), but the connection will be
+allowed to proceed.
+If the value is a list, it should have the form
+
+   ((HOST-REGEX FLAGS...) (HOST-REGEX FLAGS...) ...)
+
+where each HOST-REGEX is a regular expression to be matched
+against the hostname, and FLAGS is either t or a list of
+one or more verification flags.  The supported flags and the
+corresponding conditions to be tested are:
+
+  :trustfiles -- certificate must be issued by a trusted authority.
+  :hostname   -- hostname must match presented certificate's host name.
+  t           -- all of the above conditions are tested.
+
+If the condition test fails, an error will be signaled.
+
+If the value of this variable is t, every connection will be subjected
+to all of the tests described above."
   :group 'gnutls
   :version "24.4"
   :type '(choice