]> git.eshelyaron.com Git - emacs.git/commitdiff
Document the nil/default values of url-user-agent
authorLars Magne Ingebrigtsen <larsi@gnus.org>
Sun, 24 Apr 2016 12:55:15 +0000 (14:55 +0200)
committerLars Magne Ingebrigtsen <larsi@gnus.org>
Sun, 24 Apr 2016 12:55:15 +0000 (14:55 +0200)
* doc/misc/url.texi (Customization): Document the nil/default
values of url-user-agent.

doc/misc/url.texi
etc/NEWS

index 14a4c96cc47845cc2de360b96d16a62f39df3034..0a96a5428b1b5571f04458b1a42abfcd095ba014 100644 (file)
@@ -1337,10 +1337,16 @@ Connect directly.
 @end defopt
 
 @defopt url-user-agent
-The User Agent string used for sending HTTP/HTTPS requests.  The value
-should be a string or a function of no arguments that returns a
-string.  The default value is @w{@samp{User-Agent: @var{package-name}
-URL/Emacs}}, where @var{package-name} is the value of
+The User Agent string used for sending @acronym{HTTP}/@acronym{HTTPS}
+requests.  The value should be @code{nil}, which means that no
+@samo{User-Agent} header is generated, @code{default}, which means
+that a string is generated based on the setting of
+@code{url-privacy-leve}, a string or a function of no arguments that
+returns a string.
+
+The default is @code{default}, which means that the
+@w{@samp{User-Agent: @var{package-name} URL/Emacs}} string will be
+generated, where @var{package-name} is the value of
 @code{url-package-name} and its version, if they are non-@code{nil}.
 @end defopt
 
index d0afb8462a9d90f07bbe9062f694e56407dfd42a..6c7c9de4d5e2c3e52322a3e6cfede36e795c463c 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -284,7 +284,7 @@ domain.
 
 *** The URL package now support https over proxies supporting CONNECT.
 
----
++++
 *** `url-user-agent' now defaults to `default', and the User-Agent
 string is computed dynamically based on `url-privacy-level'.