Commit 8a3c245c authored by Pedro Tammela's avatar Pedro Tammela Committed by David S. Miller

net: add documentation to socket.c

Adds missing sphinx documentation to the
socket.c's functions. Also fixes some whitespaces.

I also changed the style of older documentation as an
effort to have an uniform documentation style.
Signed-off-by: default avatarPedro Tammela <pctammela@gmail.com>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 228cd2db
...@@ -83,6 +83,12 @@ enum sock_type { ...@@ -83,6 +83,12 @@ enum sock_type {
#endif /* ARCH_HAS_SOCKET_TYPES */ #endif /* ARCH_HAS_SOCKET_TYPES */
/**
* enum sock_shutdown_cmd - Shutdown types
* @SHUT_RD: shutdown receptions
* @SHUT_WR: shutdown transmissions
* @SHUT_RDWR: shutdown receptions/transmissions
*/
enum sock_shutdown_cmd { enum sock_shutdown_cmd {
SHUT_RD, SHUT_RD,
SHUT_WR, SHUT_WR,
......
...@@ -26,7 +26,7 @@ typedef __kernel_sa_family_t sa_family_t; ...@@ -26,7 +26,7 @@ typedef __kernel_sa_family_t sa_family_t;
/* /*
* 1003.1g requires sa_family_t and that sa_data is char. * 1003.1g requires sa_family_t and that sa_data is char.
*/ */
struct sockaddr { struct sockaddr {
sa_family_t sa_family; /* address family, AF_xxx */ sa_family_t sa_family; /* address family, AF_xxx */
char sa_data[14]; /* 14 bytes of protocol address */ char sa_data[14]; /* 14 bytes of protocol address */
...@@ -44,7 +44,7 @@ struct linger { ...@@ -44,7 +44,7 @@ struct linger {
* system, not 4.3. Thus msg_accrights(len) are now missing. They * system, not 4.3. Thus msg_accrights(len) are now missing. They
* belong in an obscure libc emulation or the bin. * belong in an obscure libc emulation or the bin.
*/ */
struct msghdr { struct msghdr {
void *msg_name; /* ptr to socket address structure */ void *msg_name; /* ptr to socket address structure */
int msg_namelen; /* size of socket address structure */ int msg_namelen; /* size of socket address structure */
...@@ -54,7 +54,7 @@ struct msghdr { ...@@ -54,7 +54,7 @@ struct msghdr {
unsigned int msg_flags; /* flags on received message */ unsigned int msg_flags; /* flags on received message */
struct kiocb *msg_iocb; /* ptr to iocb for async requests */ struct kiocb *msg_iocb; /* ptr to iocb for async requests */
}; };
struct user_msghdr { struct user_msghdr {
void __user *msg_name; /* ptr to socket address structure */ void __user *msg_name; /* ptr to socket address structure */
int msg_namelen; /* size of socket address structure */ int msg_namelen; /* size of socket address structure */
...@@ -122,7 +122,7 @@ struct cmsghdr { ...@@ -122,7 +122,7 @@ struct cmsghdr {
* inside range, given by msg->msg_controllen before using * inside range, given by msg->msg_controllen before using
* ancillary object DATA. --ANK (980731) * ancillary object DATA. --ANK (980731)
*/ */
static inline struct cmsghdr * __cmsg_nxthdr(void *__ctl, __kernel_size_t __size, static inline struct cmsghdr * __cmsg_nxthdr(void *__ctl, __kernel_size_t __size,
struct cmsghdr *__cmsg) struct cmsghdr *__cmsg)
{ {
...@@ -264,10 +264,10 @@ struct ucred { ...@@ -264,10 +264,10 @@ struct ucred {
/* Maximum queue length specifiable by listen. */ /* Maximum queue length specifiable by listen. */
#define SOMAXCONN 128 #define SOMAXCONN 128
/* Flags we can use with send/ and recv. /* Flags we can use with send/ and recv.
Added those for 1003.1g not all are supported yet Added those for 1003.1g not all are supported yet
*/ */
#define MSG_OOB 1 #define MSG_OOB 1
#define MSG_PEEK 2 #define MSG_PEEK 2
#define MSG_DONTROUTE 4 #define MSG_DONTROUTE 4
......
This diff is collapsed.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment