net: fix some identation issues at kernel-doc markups
Sphinx is very pedantic with regards to identation and escape sequences: ./include/net/sock.h:1967: ERROR: Unexpected indentation. ./include/net/sock.h:1969: ERROR: Unexpected indentation. ./include/net/sock.h:1970: WARNING: Block quote ends without a blank line; unexpected unindent. ./include/net/sock.h:1971: WARNING: Block quote ends without a blank line; unexpected unindent. ./include/net/sock.h:2268: WARNING: Inline emphasis start-string without end-string. ./net/core/sock.c:2686: ERROR: Unexpected indentation. ./net/core/sock.c:2687: WARNING: Block quote ends without a blank line; unexpected unindent. ./net/core/datagram.c:182: WARNING: Inline emphasis start-string without end-string. ./include/linux/netdevice.h:1444: ERROR: Unexpected indentation. ./drivers/net/phy/phy.c:381: ERROR: Unexpected indentation. ./drivers/net/phy/phy.c:382: WARNING: Block quote ends without a blank line; unexpected unindent. - Fix spacing where needed; - Properly escape constants; - Use a literal block for a race description. No functional changes. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
This commit is contained in:
parent
771b00a84b
commit
d651983dde
|
@ -377,6 +377,7 @@ static void phy_sanitize_settings(struct phy_device *phydev)
|
||||||
* @cmd: ethtool_cmd
|
* @cmd: ethtool_cmd
|
||||||
*
|
*
|
||||||
* A few notes about parameter checking:
|
* A few notes about parameter checking:
|
||||||
|
*
|
||||||
* - We don't set port or transceiver, so we don't care what they
|
* - We don't set port or transceiver, so we don't care what they
|
||||||
* were set to.
|
* were set to.
|
||||||
* - phy_start_aneg() will make sure forced settings are sane, and
|
* - phy_start_aneg() will make sure forced settings are sane, and
|
||||||
|
|
|
@ -1433,13 +1433,14 @@ enum netdev_priv_flags {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* struct net_device - The DEVICE structure.
|
* struct net_device - The DEVICE structure.
|
||||||
* Actually, this whole structure is a big mistake. It mixes I/O
|
*
|
||||||
* data with strictly "high-level" data, and it has to know about
|
* Actually, this whole structure is a big mistake. It mixes I/O
|
||||||
* almost every data structure used in the INET module.
|
* data with strictly "high-level" data, and it has to know about
|
||||||
|
* almost every data structure used in the INET module.
|
||||||
*
|
*
|
||||||
* @name: This is the first field of the "visible" part of this structure
|
* @name: This is the first field of the "visible" part of this structure
|
||||||
* (i.e. as seen by users in the "Space.c" file). It is the name
|
* (i.e. as seen by users in the "Space.c" file). It is the name
|
||||||
* of the interface.
|
* of the interface.
|
||||||
*
|
*
|
||||||
* @name_hlist: Device name hash chain, please keep it close to name[]
|
* @name_hlist: Device name hash chain, please keep it close to name[]
|
||||||
* @ifalias: SNMP alias
|
* @ifalias: SNMP alias
|
||||||
|
|
|
@ -1953,11 +1953,10 @@ static inline bool sk_has_allocations(const struct sock *sk)
|
||||||
* The purpose of the skwq_has_sleeper and sock_poll_wait is to wrap the memory
|
* The purpose of the skwq_has_sleeper and sock_poll_wait is to wrap the memory
|
||||||
* barrier call. They were added due to the race found within the tcp code.
|
* barrier call. They were added due to the race found within the tcp code.
|
||||||
*
|
*
|
||||||
* Consider following tcp code paths:
|
* Consider following tcp code paths::
|
||||||
*
|
*
|
||||||
* CPU1 CPU2
|
* CPU1 CPU2
|
||||||
*
|
* sys_select receive packet
|
||||||
* sys_select receive packet
|
|
||||||
* ... ...
|
* ... ...
|
||||||
* __add_wait_queue update tp->rcv_nxt
|
* __add_wait_queue update tp->rcv_nxt
|
||||||
* ... ...
|
* ... ...
|
||||||
|
@ -2264,7 +2263,7 @@ void __sock_tx_timestamp(__u16 tsflags, __u8 *tx_flags);
|
||||||
* @tsflags: timestamping flags to use
|
* @tsflags: timestamping flags to use
|
||||||
* @tx_flags: completed with instructions for time stamping
|
* @tx_flags: completed with instructions for time stamping
|
||||||
*
|
*
|
||||||
* Note : callers should take care of initial *tx_flags value (usually 0)
|
* Note: callers should take care of initial ``*tx_flags`` value (usually 0)
|
||||||
*/
|
*/
|
||||||
static inline void sock_tx_timestamp(const struct sock *sk, __u16 tsflags,
|
static inline void sock_tx_timestamp(const struct sock *sk, __u16 tsflags,
|
||||||
__u8 *tx_flags)
|
__u8 *tx_flags)
|
||||||
|
|
|
@ -181,7 +181,7 @@ done:
|
||||||
*
|
*
|
||||||
* This function will lock the socket if a skb is returned, so
|
* This function will lock the socket if a skb is returned, so
|
||||||
* the caller needs to unlock the socket in that case (usually by
|
* the caller needs to unlock the socket in that case (usually by
|
||||||
* calling skb_free_datagram). Returns NULL with *err set to
|
* calling skb_free_datagram). Returns NULL with @err set to
|
||||||
* -EAGAIN if no data was available or to some other value if an
|
* -EAGAIN if no data was available or to some other value if an
|
||||||
* error was detected.
|
* error was detected.
|
||||||
*
|
*
|
||||||
|
|
|
@ -2682,9 +2682,12 @@ EXPORT_SYMBOL(release_sock);
|
||||||
* @sk: socket
|
* @sk: socket
|
||||||
*
|
*
|
||||||
* This version should be used for very small section, where process wont block
|
* This version should be used for very small section, where process wont block
|
||||||
* return false if fast path is taken
|
* return false if fast path is taken:
|
||||||
|
*
|
||||||
* sk_lock.slock locked, owned = 0, BH disabled
|
* sk_lock.slock locked, owned = 0, BH disabled
|
||||||
* return true if slow path is taken
|
*
|
||||||
|
* return true if slow path is taken:
|
||||||
|
*
|
||||||
* sk_lock.slock unlocked, owned = 1, BH enabled
|
* sk_lock.slock unlocked, owned = 1, BH enabled
|
||||||
*/
|
*/
|
||||||
bool lock_sock_fast(struct sock *sk)
|
bool lock_sock_fast(struct sock *sk)
|
||||||
|
|
Loading…
Reference in New Issue