netdev - Re: [PATCHv3 net-next 04/10] docs: bridge: Add kAPI/uAPI fields

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <70546e4c-aba2-4a36-a2ac-e3ae63482ce0@gmail.com>
Date: Tue, 28 Nov 2023 20:11:18 -0800
From: Florian Fainelli <f.fainelli@...il.com>
To: Hangbin Liu <liuhangbin@...il.com>, netdev@...r.kernel.org
Cc: "David S . Miller" <davem@...emloft.net>, David Ahern
 <dsahern@...nel.org>, Eric Dumazet <edumazet@...gle.com>,
 Jakub Kicinski <kuba@...nel.org>, Paolo Abeni <pabeni@...hat.com>,
 Ido Schimmel <idosch@...sch.org>, Nikolay Aleksandrov <razor@...ckwall.org>,
 Roopa Prabhu <roopa@...dia.com>,
 Stephen Hemminger <stephen@...workplumber.org>,
 Florian Westphal <fw@...len.de>, Andrew Lunn <andrew@...n.ch>,
 Vladimir Oltean <olteanv@...il.com>, Jiri Pirko <jiri@...nulli.us>,
 Marc Muehlfeld <mmuehlfe@...hat.com>
Subject: Re: [PATCHv3 net-next 04/10] docs: bridge: Add kAPI/uAPI fields

On 11/28/2023 12:49 AM, Hangbin Liu wrote:
> Add kAPI/uAPI field for bridge doc. Update struct net_bridge_vlan
> comments to fix doc build warning.
> 
> Signed-off-by: Hangbin Liu <liuhangbin@...il.com>
> ---
>   Documentation/networking/bridge.rst | 26 ++++++++++++++++++++++++++
>   net/bridge/br_private.h             |  2 ++
>   2 files changed, 28 insertions(+)
> 
> diff --git a/Documentation/networking/bridge.rst b/Documentation/networking/bridge.rst
> index de112e92a305..5d6d3c0c15c1 100644
> --- a/Documentation/networking/bridge.rst
> +++ b/Documentation/networking/bridge.rst
> @@ -12,6 +12,32 @@ independent way. Packets are forwarded based on Layer 2 destination Ethernet
>   address, rather than IP address (like a router). Since forwarding is done
>   at Layer 2, all Layer 3 protocols can pass through a bridge transparently.
>   
> +Bridge kAPI
> +===========
> +
> +Here are some core structures of bridge code.
> +
> +.. kernel-doc:: net/bridge/br_private.h
> +   :identifiers: net_bridge_vlan
> +
> +Bridge uAPI
> +===========
> +
> +Modern Linux bridge uAPI is accessed via Netlink interface. You can find
> +below files where the bridge and bridge port netlink attributes are defined.

You dropped the sysfs documentation upon Nikolay's request which is 
fine, maybe a note here that sysfs is deprecated and only provided for 
backward compatibility.

Looks good otherwise:

Reviewed-by: Florian Fainelli <florian.fainelli@...adcom.com>
-- 
Florian