procyberian/emacs
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve documentation of 'network-lookup-address-info'

Browse source 
* 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.
This commit is contained in:
Eli Zaretskii 2020-12-31 22:27:30 +02:00
parent c6d5555646
commit 74a77ef299
2 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

3
doc/lispref/processes.texi
View file

@ -3082,7 +3082,8 @@ signaled. Call @code{puny-encode-domain} on @var{name}
first if you wish to lookup internationalized hostnames. first if you wish to lookup internationalized hostnames.
If successful it returns a list of Lisp representations of network 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 By default both IPv4 and IPv6 lookups are attempted. The optional
argument @var{family} controls this behavior, specifying the symbol argument @var{family} controls this behavior, specifying the symbol

5
src/process.c
View 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, DEFUN ("network-lookup-address-info", Fnetwork_lookup_address_info,
Snetwork_lookup_address_info, 1, 2, 0, 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 Optional parameter FAMILY controls whether to look up IPv4 or IPv6
addresses. The default of nil means both, symbol `ipv4' means IPv4 addresses. The default of nil means both, symbol `ipv4' means IPv4
only, symbol `ipv6' means IPv6 only. Returns a list of addresses, or 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 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 name, Lisp_Object family)
{ {
Lisp_Object addresses = Qnil; Lisp_Object addresses = Qnil;