bug#81505: Fixes for doc/misc/url.texi

Tim Landscheidt <[email protected]>
Newsgroups gmane.emacs.bugs
Organization https://www.tim-landscheidt.de/
Message-ID <[email protected]>
Package: emacs
Severity: minor
Tags: patch

I noticed a formatting error in the url info manual, so
while at it I also fixed two other minor imperfections and
synchronized the function signatures with the code.
0001-Link-directly-to-referenced-node-in-CL-manual.patch (text/x-patch, 630 B)
diff --git a/doc/misc/url.texi b/doc/misc/url.texi
index a07aa805fa9..56199b109fd 100644
--- a/doc/misc/url.texi
+++ b/doc/misc/url.texi
@@ -140,7 +140,7 @@ URI Parsing
   The return value of @code{url-generic-parse-url}, and the argument
 expected by @code{url-recreate-url}, is a @dfn{parsed URI}: a CL
 structure whose slots hold the various components of the URI@.
-@xref{Top,the CL Manual,,cl,GNU Emacs Common Lisp Emulation}, for
+@xref{Structures,the CL Manual,,cl,GNU Emacs Common Lisp Emulation}, for
 details about CL structures.  Most of the other functions in the
 @code{url} library act on parsed URIs.
 
-- 
2.55.0
0002-Remove-superfluous-space.patch (text/x-patch, 536 B)
diff --git a/doc/misc/url.texi b/doc/misc/url.texi
index 56199b109fd..2013e1f326d 100644
--- a/doc/misc/url.texi
+++ b/doc/misc/url.texi
@@ -336,7 +336,7 @@ Retrieving URLs
 @cindex status of GnuTLS connection, as provided by @code{url-retrieve}
 @findex gnutls-peer-status-warning-describe
 @findex gnutls-peer-status
-@item  (:peer @var{gnutls-information})
+@item (:peer @var{gnutls-information})
 This means that GnuTLS was used for a TLS connection to the peer.  The
 @var{gnutls-information} has the following form:
 
-- 
2.55.0
0003-Fix-formatting-for-variable.patch (text/x-patch, 483 B)
diff --git a/doc/misc/url.texi b/doc/misc/url.texi
index 2013e1f326d..4ff25d372ce 100644
--- a/doc/misc/url.texi
+++ b/doc/misc/url.texi
@@ -938,7 +938,7 @@ Disk Caching
 @defun url-cache-expired
 This function returns non-@code{nil} if a cache entry has expired (or is absent).
 The arguments are a URL and optional expiration delay in seconds
-(default @var{url-cache-expire-time}).
+(default @code{url-cache-expire-time}).
 @end defun
 
 @defopt url-cache-expire-time
-- 
2.55.0
0004-Synchronize-function-signatures-with-code.patch (text/x-patch, 5.2 KB)
diff --git a/doc/misc/url.texi b/doc/misc/url.texi
index 4ff25d372ce..942f7305872 100644
--- a/doc/misc/url.texi
+++ b/doc/misc/url.texi
@@ -127,11 +127,11 @@ URI Parsing
 @code{url-recreate-url}, which converts a parsed URI back into a URI
 string.
 
-@defun url-generic-parse-url uri-string
-This function returns a parsed version of the string @var{uri-string}.
+@defun url-generic-parse-url url
+This function returns a parsed version of the string @var{url}.
 @end defun
 
-@defun url-recreate-url uri-obj
+@defun url-recreate-url urlobj
 @cindex unparsing URLs
 Given a parsed URI, this function returns the corresponding URI string.
 @end defun
@@ -240,9 +240,9 @@ URI Encoding
 string containing arbitrary characters to one that is properly
 percent-encoded in accordance with RFC 3986.
 
-@defun url-encode-url url-string
+@defun url-encode-url url
 This function return a properly URI-encoded version of
-@var{url-string}.  It also performs @dfn{URI normalization},
+@var{url}.  It also performs @dfn{URI normalization},
 e.g., converting the scheme component to lowercase if it was
 previously uppercase.
 @end defun
@@ -272,8 +272,8 @@ URI Encoding
 non-@code{nil} if character N is allowed.
 @end defun
 
-@defun url-unhex-string string &optional allow-newlines
-This function replaces percent-encoding sequences in @var{string} with
+@defun url-unhex-string str &optional allow-newlines
+This function replaces percent-encoding sequences in @var{str} with
 their character equivalents, and returns the resulting string.
 
 If @var{allow-newlines} is non-@code{nil}, it allows the decoding of
@@ -294,20 +294,20 @@ Retrieving URLs
 passed through @code{url-encode-url} before using it, to ensure that
 it is properly URI-encoded (@pxref{URI Encoding}).
 
-@defun url-retrieve-synchronously url &optional silent no-cookies timeout
+@defun url-retrieve-synchronously url &optional silent inhibit-cookies timeout
 This function synchronously retrieves the data specified by @var{url},
 and returns a buffer containing the data.  The return value is
 @code{nil} if there is no data associated with the URL (as is the case
 for @code{dired}, @code{info}, and @code{mailto} URLs).
 
 If the optional argument @var{silent} is non-@code{nil}, progress
-messages are suppressed.  If the optional argument @var{no-cookies} is
+messages are suppressed.  If the optional argument @var{inhibit-cookies} is
 non-@code{nil}, cookies are not stored or sent.  If the optional
 argument @var{timeout} is non-@code{nil}, it should be a number that
 says (in seconds) how long to wait for a response before giving up.
 @end defun
 
-@defun url-retrieve url callback &optional cbargs silent no-cookies
+@defun url-retrieve url callback &optional cbargs silent inhibit-cookies
 This function retrieves @var{url} asynchronously, calling the function
 @var{callback} when the object has been completely retrieved.  The
 return value is the buffer into which the data will be inserted, or
@@ -362,11 +362,11 @@ Retrieving URLs
 MIME headers associated with the data retrieval.
 
 If the optional argument @var{silent} is non-@code{nil}, progress
-messages are suppressed.  If the optional argument @var{no-cookies} is
+messages are suppressed.  If the optional argument @var{inhibit-cookies} is
 non-@code{nil}, cookies are not stored or sent.
 @end defun
 
-@defun url-queue-retrieve url callback &optional cbargs silent no-cookies
+@defun url-queue-retrieve url callback &optional cbargs silent inhibit-cookies
 This function acts like @code{url-retrieve}, but with limits on the
 number of concurrently-running network processes.  The option
 @code{url-queue-parallel-processes} controls the number of concurrent
@@ -451,7 +451,7 @@ Cookies
 @kbd{C-k} (@code{url-cookie-delete}) command.
 @end defun
 
-@defun url-cookie-delete-cookies &optional regexp
+@defun url-cookie-delete-cookies &optional regexp keep
 This function takes a regular expression as its parameters and deletes
 all cookies from that domain.  If @var{regexp} is @code{nil}, delete
 all cookies.
@@ -533,7 +533,7 @@ HTTP URL Options
 the URL@.
 
 @defun url-http-options url
-Returns a property list describing options available for URL@.  The
+Returns a property list describing options available for @var{url}.  The
 property list members are:
 
 @table @code
@@ -935,7 +935,7 @@ Disk Caching
 @end smallexample
 @end defun
 
-@defun url-cache-expired
+@defun url-cache-expired url &optional expire-time
 This function returns non-@code{nil} if a cache entry has expired (or is absent).
 The arguments are a URL and optional expiration delay in seconds
 (default @code{url-cache-expire-time}).
@@ -946,7 +946,7 @@ Disk Caching
 expire-time argument of the function @code{url-cache-expired}.
 @end defopt
 
-@defun url-fetch-from-cache
+@defun url-fetch-from-cache url
 This function takes a URL as its argument and returns a buffer
 containing the data cached for that URL.
 @end defun
@@ -1037,7 +1037,7 @@ Gateways in general
 implemented using this.}  The library's basic function responsible for
 making connections is @code{url-open-stream}.
 
-@defun url-open-stream name buffer host service
+@defun url-open-stream name buffer host service &optional gateway-method
 @cindex opening a stream
 @cindex stream, opening
 Open a stream to @var{host}, possibly via a gateway.  The other
-- 
2.55.0
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.