[PATCH net] netlink: specs: netdev: clarify the page pool API a little

[PATCH net] netlink: specs: netdev: clarify the page pool API a little

[Jakub Kicinski]

The phrasing of the page-pool-get doc is very confusing.
It's supposed to highlight that support depends on the driver
doing its part but it sounds like orphaned page pools won't
be visible.

The description of the ifindex is completely wrong.
We move the page pool to loopback and skip the attribute if
ifindex is loopback.

Link: https://lore.kernel.org/20260104084347.5de3a537@kernel.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
CC: donald.hunter@gmail.com
CC: hawk@kernel.org
---
 Documentation/netlink/specs/netdev.yaml | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/Documentation/netlink/specs/netdev.yaml b/Documentation/netlink/specs/netdev.yaml
index 82bf5cb2617d..596c306ce52b 100644
--- a/Documentation/netlink/specs/netdev.yaml
+++ b/Documentation/netlink/specs/netdev.yaml
@@ -142,7 +142,7 @@ doc: >-
         name: ifindex
         doc: |
           ifindex of the netdev to which the pool belongs.
-          May be reported as 0 if the page pool was allocated for a netdev
+          May not be reported if the page pool was allocated for a netdev
           which got destroyed already (page pools may outlast their netdevs
           because they wait for all memory to be returned).
         type: u32
@@ -601,7 +601,9 @@ doc: >-
       name: page-pool-get
       doc: |
         Get / dump information about Page Pools.
-        (Only Page Pools associated with a net_device can be listed.)
+        Only Page Pools associated by the driver with a net_device
+        can be listed. ifindex will not be reported if the net_device
+        no longer exists.
       attribute-set: page-pool
       do:
         request:
-- 
2.52.0

Re: [PATCH net] netlink: specs: netdev: clarify the page pool API a little

[Donald Hunter]

Jakub Kicinski <kuba@kernel.org> writes:

> The phrasing of the page-pool-get doc is very confusing.
> It's supposed to highlight that support depends on the driver
> doing its part but it sounds like orphaned page pools won't
> be visible.
>
> The description of the ifindex is completely wrong.
> We move the page pool to loopback and skip the attribute if
> ifindex is loopback.
>
> Link: https://lore.kernel.org/20260104084347.5de3a537@kernel.org
> Signed-off-by: Jakub Kicinski <kuba@kernel.org>
> ---
> CC: donald.hunter@gmail.com
> CC: hawk@kernel.org
> ---
>  Documentation/netlink/specs/netdev.yaml | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)

Reviewed-by: Donald Hunter <donald.hunter@gmail.com>

Re: [PATCH net] netlink: specs: netdev: clarify the page pool API a little

[Jesper Dangaard Brouer]

On 05/01/2026 12.27, Donald Hunter wrote:
> Jakub Kicinski <kuba@kernel.org> writes:
> 
>> The phrasing of the page-pool-get doc is very confusing.
>> It's supposed to highlight that support depends on the driver
>> doing its part but it sounds like orphaned page pools won't
>> be visible.
>>
>> The description of the ifindex is completely wrong.
>> We move the page pool to loopback and skip the attribute if
>> ifindex is loopback.
>>
>> Link: https://lore.kernel.org/20260104084347.5de3a537@kernel.org
>> Signed-off-by: Jakub Kicinski <kuba@kernel.org>
>> ---
>> CC: donald.hunter@gmail.com
>> CC: hawk@kernel.org
>> ---
>>   Documentation/netlink/specs/netdev.yaml | 6 ++++--
>>   1 file changed, 4 insertions(+), 2 deletions(-)
> 
> Reviewed-by: Donald Hunter <donald.hunter@gmail.com>

Acked-by: Jesper Dangaard Brouer <hawk@kernel.org>

Re: [PATCH net] netlink: specs: netdev: clarify the page pool API a little

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net.git (main)
by Jakub Kicinski <kuba@kernel.org>:

On Sun,  4 Jan 2026 08:52:32 -0800 you wrote:
> The phrasing of the page-pool-get doc is very confusing.
> It's supposed to highlight that support depends on the driver
> doing its part but it sounds like orphaned page pools won't
> be visible.
> 
> The description of the ifindex is completely wrong.
> We move the page pool to loopback and skip the attribute if
> ifindex is loopback.
> 
> [...]

Here is the summary with links:
  - [net] netlink: specs: netdev: clarify the page pool API a little
    https://git.kernel.org/netdev/net/c/86c22d475cbc

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html