[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: inet_pton documentation
From: |
Simon Josefsson |
Subject: |
Re: inet_pton documentation |
Date: |
Thu, 29 Jun 2006 15:33:54 +0200 |
User-agent: |
Gnus/5.110006 (No Gnus v0.6) Emacs/22.0.50 (gnu/linux) |
Bruno Haible <address@hidden> writes:
> Hi Simon,
>
> Can we add some documentation here? I don't find that the comment in
> the implementation is clear enough.
Please install. This is one case where I agree it is OK to put the
comment in the header file -- we shouldn't modify the source file too
much since it is from glibc. The source file also have some
documentation already; having two documentation in the same file seems
confusing.
Thanks!
> diff -r -c3 --exclude=CVS gnulib-20060614-modified/lib/inet_pton.h
> gnulib-20060628-modified/lib/inet_pton.h
> *** gnulib-20060614-modified/lib/inet_pton.h 2006-06-29 01:30:47.000000000
> +0200
> --- gnulib-20060628-modified/lib/inet_pton.h 2006-06-29 00:32:23.000000000
> +0200
> ***************
> *** 21,26 ****
> --- 21,36 ----
> # include <arpa/inet.h>
> #endif
>
> + /* Convert an internet address from a printable, presentable format to
> internal
> + format.
> + AF is an internet address family, such as AF_INET or AF_INET6.
> + SRC points to a printable representation of the address (in numeric
> form, not
> + surrounded by [...], no DNS lookup is done).
> + DST points to a 'struct in_addr' (for AF_INET) or 'struct in6_addr'
> + (for AF_INET6).
> + If the string at SRC is a valid printable representation of an address
> of the
> + given family, store the internal format of the address at DST and return
> 1.
> + If it is invalid, return 0. Upon error, set errno and return -1. */
> #if !HAVE_DECL_INET_PTON
> extern int inet_pton (int af, const char *restrict src, void *restrict dst);
> #endif