]> git.eshelyaron.com Git - emacs.git/commitdiff
Improve documentation of 'network-lookup-address-info'
authorEli Zaretskii <eliz@gnu.org>
Thu, 31 Dec 2020 20:27:30 +0000 (22:27 +0200)
committerEli Zaretskii <eliz@gnu.org>
Thu, 31 Dec 2020 20:27:30 +0000 (22:27 +0200)
* src/process.c (Fnetwork_lookup_address_info):
* doc/lispref/processes.texi (Misc Network): Document the error
message emitted by 'network-lookup-address-info' when it fails.

doc/lispref/processes.texi
src/process.c

index 6970f718ee01ed882aaa7faca2c73e8ea6a5f111..94818beb4c9636f5dfe7f8eacee511baab63f99c 100644 (file)
@@ -3082,7 +3082,8 @@ signaled. Call @code{puny-encode-domain} on @var{name}
 first if you wish to lookup internationalized hostnames.
 
 If successful it returns a list of Lisp representations of network
-addresses, otherwise it returns @code{nil}.
+addresses, otherwise it returns @code{nil}.  In the latter case, it
+also displays the error message hopefully explaining what went wrong.
 
 By default both IPv4 and IPv6 lookups are attempted.  The optional
 argument @var{family} controls this behavior, specifying the symbol
index 91d426103d8ccad59fa2c72b3a2494e83bae3849..27808848972db21e17cfe2981318707d8c172cc8 100644 (file)
@@ -4664,12 +4664,13 @@ network_lookup_address_info_1 (Lisp_Object host, const char *service,
 
 DEFUN ("network-lookup-address-info", Fnetwork_lookup_address_info,
        Snetwork_lookup_address_info, 1, 2, 0,
-       doc: /* Look up ip address info of NAME.
+       doc: /* Look up Internet Protocol (IP) address info of NAME.
 Optional parameter FAMILY controls whether to look up IPv4 or IPv6
 addresses.  The default of nil means both, symbol `ipv4' means IPv4
 only, symbol `ipv6' means IPv6 only.  Returns a list of addresses, or
 nil if none were found.  Each address is a vector of integers, as per
-the description of ADDRESS in `make-network-process'.  */)
+the description of ADDRESS in `make-network-process'.  In case of
+error displays the error message.  */)
      (Lisp_Object name, Lisp_Object family)
 {
   Lisp_Object addresses = Qnil;