diff mbox series

[net,v2] docs: net: fix documentation on .ndo_get_stats

Message ID 20210105012224.1681573-1-kuba@kernel.org (mailing list archive)
State Accepted
Delegated to: Netdev Maintainers
Headers show
Series [net,v2] docs: net: fix documentation on .ndo_get_stats | expand

Checks

Context Check Description
netdev/cover_letter success Link
netdev/fixes_present success No Fixes tags, but series doesn't touch code
netdev/patch_count success Link
netdev/tree_selection success Clearly marked for net
netdev/subject_prefix success Link
netdev/cc_maintainers warning 2 maintainers not CCed: corbet@lwn.net linux-doc@vger.kernel.org
netdev/source_inline success Was 0 now: 0
netdev/verify_signedoff success Link
netdev/module_param success Was 0 now: 0
netdev/build_32bit success Errors and warnings before: 43 this patch: 43
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/verify_fixes success Link
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 10 lines checked
netdev/build_allmodconfig_warn success Errors and warnings before: 35 this patch: 35
netdev/header_inline success Link
netdev/stable success Stable not CCed

Commit Message

Jakub Kicinski Jan. 5, 2021, 1:22 a.m. UTC
Fix calling context.

Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
 Documentation/networking/netdevices.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Vladimir Oltean Jan. 5, 2021, 11:51 a.m. UTC | #1
On Mon, Jan 04, 2021 at 05:22:24PM -0800, Jakub Kicinski wrote:
> Fix calling context.
> 
> Signed-off-by: Jakub Kicinski <kuba@kernel.org>
> ---
>  Documentation/networking/netdevices.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/networking/netdevices.rst b/Documentation/networking/netdevices.rst
> index 5a85fcc80c76..e65665c5ab50 100644
> --- a/Documentation/networking/netdevices.rst
> +++ b/Documentation/networking/netdevices.rst
> @@ -64,8 +64,8 @@ struct net_device synchronization rules
>  	Context: process
>  
>  ndo_get_stats:
> -	Synchronization: dev_base_lock rwlock.
> -	Context: nominally process, but don't sleep inside an rwlock
> +	Synchronization: rtnl_lock() semaphore, dev_base_lock rwlock, or RCU.
> +	Context: atomic (can't sleep under rwlock or RCU)
>  
>  ndo_start_xmit:
>  	Synchronization: __netif_tx_lock spinlock.
> -- 
> 2.26.2
> 

Reviewed-by: Vladimir Oltean <olteanv@gmail.com>
David Miller Jan. 6, 2021, 12:42 a.m. UTC | #2
From: Jakub Kicinski <kuba@kernel.org>
Date: Mon,  4 Jan 2021 17:22:24 -0800

> Fix calling context.
> 
> Signed-off-by: Jakub Kicinski <kuba@kernel.org>

Applied, thanks.
diff mbox series

Patch

diff --git a/Documentation/networking/netdevices.rst b/Documentation/networking/netdevices.rst
index 5a85fcc80c76..e65665c5ab50 100644
--- a/Documentation/networking/netdevices.rst
+++ b/Documentation/networking/netdevices.rst
@@ -64,8 +64,8 @@  struct net_device synchronization rules
 	Context: process
 
 ndo_get_stats:
-	Synchronization: dev_base_lock rwlock.
-	Context: nominally process, but don't sleep inside an rwlock
+	Synchronization: rtnl_lock() semaphore, dev_base_lock rwlock, or RCU.
+	Context: atomic (can't sleep under rwlock or RCU)
 
 ndo_start_xmit:
 	Synchronization: __netif_tx_lock spinlock.