[PATCH 5/5] manual: Document error codes missing for 'inet_pton'
Florian Weimer
fweimer@redhat.com
Mon May 26 13:31:07 GMT 2025
* Maciej W. Rozycki:
> From: Maciej W. Rozycki <macro@redhat.com>
>
> Add documentation for EAFNOSUPPORT error code returned, and the possible
> return values on failure.
> ---
> manual/socket.texi | 11 +++++++++++
> 1 file changed, 11 insertions(+)
>
> glibc-doc-inet_pton-err.diff
>
> Index: glibc/manual/socket.texi
> ===================================================================
> --- glibc.orig/manual/socket.texi
> +++ glibc/manual/socket.texi
> @@ -1222,6 +1222,17 @@ either @code{AF_INET} or @code{AF_INET6}
> address being converted. @var{cp} is a pointer to the input string, and
> @var{buf} is a pointer to a buffer for the result. It is the caller's
> responsibility to make sure the buffer is large enough.
> +
> +The return value is @code{1} on success. On failure, the function's
> +return value is zero if @var{cp} does not point to a valid address string
> +for the address family @var{af} requested, or otherwise the function's
> +return value is @code{-1} and @code{errno} is set accordingly. The
> +following @code{errno} values are specific to this function:
> +
> +@table @code
> +@item EAFNOSUPPORT
> +The address family requested is neither @code{AF_INET} nor @code{AF_INET6}.
> +@end table
> @end deftypefun
>
> @deftypefun {const char *} inet_ntop (int @var{af}, const void *@var{cp}, char *@var{buf}, socklen_t @var{len})
This one is okay as well.
Reviewed-by: Florian Weimer <fweimer@redhat.com>
Thanks,
Florian
More information about the Libc-alpha
mailing list