[Emacs-diffs] /srv/bzr/emacs/trunk r110532: Doc fix for url-http.

[Chong Yidong]

------------------------------------------------------------
revno: 110532
fixes bug: http://debbugs.gnu.org/6407
committer: Chong Yidong <address@hidden>
branch nick: trunk
timestamp: Sat 2012-10-13 17:37:25 +0800
message:
  Doc fix for url-http.
  
  * url-http.el (url-http):
  * url.el (url-retrieve-internal): Doc fix.
modified:
  lisp/url/ChangeLog
  lisp/url/url-http.el
  lisp/url/url.el

=== modified file 'lisp/url/ChangeLog'
--- a/lisp/url/ChangeLog        2012-10-08 07:47:23 +0000
+++ b/lisp/url/ChangeLog        2012-10-13 09:37:25 +0000
@@ -1,3 +1,8 @@
+2012-10-13  Chong Yidong  <address@hidden>
+
+       * url-http.el (url-http):
+       * url.el (url-retrieve-internal): Doc fix (Bug#6407).
+
 2012-10-08  Glenn Morris  <address@hidden>
 
        * url-methods.el (url-scheme-get-property): url-https.el was

=== modified file 'lisp/url/url-http.el'
--- a/lisp/url/url-http.el      2012-10-02 03:48:01 +0000
+++ b/lisp/url/url-http.el      2012-10-13 09:37:25 +0000
@@ -1150,8 +1150,12 @@
 (defun url-http (url callback cbargs &optional retry-buffer)
   "Retrieve URL via HTTP asynchronously.
 URL must be a parsed URL.  See `url-generic-parse-url' for details.
-When retrieval is completed, the function CALLBACK is executed with
-CBARGS as the arguments.
+
+When retrieval is completed, execute the function CALLBACK, using
+the arguments listed in CBARGS.  The first element in CBARGS
+should be a plist describing what has happened so far during the
+request, as described in the docstring of `url-retrieve' (if in
+doubt, specify nil).
 
 Optional arg RETRY-BUFFER, if non-nil, specifies the buffer of a
 previous `url-http' call, which is being re-attempted."

=== modified file 'lisp/url/url.el'
--- a/lisp/url/url.el   2012-07-11 23:13:41 +0000
+++ b/lisp/url/url.el   2012-10-13 09:37:25 +0000
@@ -131,9 +131,9 @@
 CALLBACK is called when the object has been completely retrieved, with
 the current buffer containing the object, and any MIME headers associated
 with it.  It is called as (apply CALLBACK STATUS CBARGS).
-STATUS is a list with an even number of elements representing
-what happened during the request, with most recent events first,
-or an empty list if no events have occurred.  Each pair is one of:
+STATUS is a plist representing what happened during the request,
+with most recent events first, or an empty list if no events have
+occurred.  Each pair is one of:
 
 \(:redirect REDIRECTED-TO) - the request was redirected to this URL
 \(:error (ERROR-SYMBOL . DATA)) - an error occurred.  The error can be
@@ -169,8 +169,10 @@
 (defun url-retrieve-internal (url callback cbargs &optional silent
                                  inhibit-cookies)
   "Internal function; external interface is `url-retrieve'.
-CBARGS is what the callback will actually receive - the first item is
-the list of events, as described in the docstring of `url-retrieve'.
+CBARGS is the list of arguments that the callback function will
+receive; its first element should be a plist specifying what has
+happened so far during the request, as described in the docstring
+of `url-retrieve' (if in doubt, specify nil).
 
 If SILENT, don't message progress reports and the like.
 If INHIBIT-COOKIES, cookies will neither be stored nor sent to