Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 93ac0ef0 authored by Amerigo Wang's avatar Amerigo Wang Committed by David S. Miller
Browse files

net: add doc for in4_pton() 



It is not easy to use in4_pton() correctly without reading
its definition, so add some doc for it.

Cc: David S. Miller <davem@davemloft.net>
Signed-off-by: default avatarCong Wang <amwang@redhat.com>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 28194fcd

net/core/utils.c

+12 −0
Original line number Diff line number Diff line
@@ -107,6 +107,18 @@ static inline int xdigit2bin(char c, int delim) 
	return IN6PTON_UNKNOWN;

}



/**

 * in4_pton - convert an IPv4 address from literal to binary representation

 * @src: the start of the IPv4 address string

 * @srclen: the length of the string, -1 means strlen(src)

 * @dst: the binary (u8[4] array) representation of the IPv4 address

 * @delim: the delimiter of the IPv4 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 in4_pton(const char *src, int srclen,

	     u8 *dst,

	     int delim, const char **end)