diff options
| author | Amerigo Wang <amwang@redhat.com> | 2012-10-11 21:06:16 +0000 |
|---|---|---|
| committer | David S. Miller <davem@davemloft.net> | 2012-10-12 13:56:52 -0400 |
| commit | 28194fcdc150e4d5b418d01db3c29058f60ef32c (patch) | |
| tree | 9988b666e6551dff9f032f390ffe23a20b4c5227 | |
| parent | 8437e7610c2d3e06f87f71fb82e10ed4b291812a (diff) | |
| download | linux-28194fcdc150e4d5b418d01db3c29058f60ef32c.tar.bz2 | |
net: add doc for in6_pton()
It is not easy to use in6_pton() correctly without reading
its definition, so add some doc for it.
Cc: David S. Miller <davem@davemloft.net>
Signed-off-by: Cong Wang <amwang@redhat.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
| -rw-r--r-- | net/core/utils.c | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/net/core/utils.c b/net/core/utils.c index f5613d569c23..30f3879faecc 100644 --- a/net/core/utils.c +++ b/net/core/utils.c @@ -161,6 +161,18 @@ out: } EXPORT_SYMBOL(in4_pton); +/** + * in6_pton - convert an IPv6 address from literal to binary representation + * @src: the start of the IPv6 address string + * @srclen: the length of the string, -1 means strlen(src) + * @dst: the binary (u8[16] array) representation of the IPv6 address + * @delim: the delimiter of the IPv6 address in @src, -1 means no delimiter + * @end: A pointer to the end of the parsed string will be placed here + * + * Return one on success, return zero when any error occurs + * and @end will point to the end of the parsed string. + * + */ int in6_pton(const char *src, int srclen, u8 *dst, int delim, const char **end) |