Skip to contentSkip to conversation

docs: networking: clarify intended audience of netdevices.rst

PATCH Applied Jakub Kicinski 3 participants 3 messages Apr 15, 2025 – Apr 17, 2025

Subsystems (3)
lore
Share & tools
lore

Jakub Kicinski

author maintainer
#0 lore raw

PATCH 1/1 docs: networking: clarify intended audience of netdevices.rst

The netdevices doc is dangerously broad. At least make it clear that it's intended for developers, not for users.

---
 Documentation/networking/netdevices.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/networking/netdevices.rst +1 -1
index eab601ab2db0..abfd584f1874 100644
@@ -8,7 +8,7 @@ Network Devices, the Kernel, and You!
 Introduction
 ============
 The following is a random collection of documentation regarding
-network devices.
+network devices. It is intended for driver developers.
 
 struct net_device lifetime rules
 ================================
Signature · 1 line
2.49.0
#2 lore raw
In reply to Jakub Kicinski
This patch was applied to netdev/net-next.git (main) by Jakub Kicinski <[email protected]>:

Hello:

This patch was applied to netdev/net-next.git (main) by Jakub Kicinski <[email protected]>:

Quoted 7 lines · On Tue, 15 Apr 2025 10:26:53 -0700 you wrote:

The netdevices doc is dangerously broad. At least make it clear that it's intended for developers, not for users.

---
 Documentation/networking/netdevices.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Here is the summary with links:
- [net-next] docs: networking: clarify intended audience of netdevices.rst

    https://git.kernel.org/netdev/net-next/c/49593c298cf7

You are awesome, thank you!

Signature · 2 lines
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html