netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Florian Fainelli <f.fainelli@gmail.com>
To: Hangbin Liu <liuhangbin@gmail.com>, netdev@vger.kernel.org
Cc: "David S . Miller" <davem@davemloft.net>,
	David Ahern <dsahern@kernel.org>,
	Eric Dumazet <edumazet@google.com>,
	Jakub Kicinski <kuba@kernel.org>, Paolo Abeni <pabeni@redhat.com>,
	Ido Schimmel <idosch@idosch.org>,
	Nikolay Aleksandrov <razor@blackwall.org>,
	Roopa Prabhu <roopa@nvidia.com>,
	Stephen Hemminger <stephen@networkplumber.org>,
	Florian Westphal <fw@strlen.de>, Andrew Lunn <andrew@lunn.ch>,
	Vladimir Oltean <olteanv@gmail.com>,
	Jiri Pirko <jiri@resnulli.us>,
	Marc Muehlfeld <mmuehlfe@redhat.com>
Subject: Re: [PATCHv3 net-next 04/10] docs: bridge: Add kAPI/uAPI fields
Date: Tue, 28 Nov 2023 20:11:18 -0800	[thread overview]
Message-ID: <70546e4c-aba2-4a36-a2ac-e3ae63482ce0@gmail.com> (raw)
In-Reply-To: <20231128084943.637091-5-liuhangbin@gmail.com>



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@gmail.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@broadcom.com>
-- 
Florian

  parent reply	other threads:[~2023-11-29  4:11 UTC|newest]

Thread overview: 29+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-11-28  8:49 [PATCHv3 net-next 00/10] Doc: update bridge doc Hangbin Liu
2023-11-28  8:49 ` [PATCHv3 net-next 01/10] docs: bridge: update doc format to rst Hangbin Liu
2023-11-28 22:46   ` Stephen Hemminger
2023-11-29  7:34     ` Hangbin Liu
2023-11-29  4:16   ` Florian Fainelli
2023-11-28  8:49 ` [PATCHv3 net-next 02/10] net: bridge: add document for IFLA_BR enum Hangbin Liu
2023-11-29 18:37   ` Vladimir Oltean
2023-11-28  8:49 ` [PATCHv3 net-next 03/10] net: bridge: add document for IFLA_BRPORT enum Hangbin Liu
2023-11-28  8:49 ` [PATCHv3 net-next 04/10] docs: bridge: Add kAPI/uAPI fields Hangbin Liu
2023-11-28 22:47   ` Stephen Hemminger
2023-11-29  4:11   ` Florian Fainelli [this message]
2023-11-28  8:49 ` [PATCHv3 net-next 05/10] docs: bridge: add STP doc Hangbin Liu
2023-11-28 22:48   ` Stephen Hemminger
2023-11-29  7:43     ` Hangbin Liu
2023-11-29 15:10       ` Stephen Hemminger
2023-11-29 18:46       ` Vladimir Oltean
2023-11-29  4:21   ` Florian Fainelli
2023-11-29 18:48   ` Vladimir Oltean
2023-11-28  8:49 ` [PATCHv3 net-next 06/10] docs: bridge: add VLAN doc Hangbin Liu
2023-11-29  4:12   ` Florian Fainelli
2023-11-29 18:40   ` Vladimir Oltean
2023-11-28  8:49 ` [PATCHv3 net-next 07/10] docs: bridge: add multicast doc Hangbin Liu
2023-11-29  4:15   ` Florian Fainelli
2023-11-28  8:49 ` [PATCHv3 net-next 08/10] docs: bridge: add switchdev doc Hangbin Liu
2023-11-29  4:16   ` Florian Fainelli
2023-11-28  8:49 ` [PATCHv3 net-next 09/10] docs: bridge: add netfilter doc Hangbin Liu
2023-11-29  4:18   ` Florian Fainelli
2023-11-28  8:49 ` [PATCHv3 net-next 10/10] docs: bridge: add other features Hangbin Liu
2023-11-29  4:09   ` Florian Fainelli

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=70546e4c-aba2-4a36-a2ac-e3ae63482ce0@gmail.com \
    --to=f.fainelli@gmail.com \
    --cc=andrew@lunn.ch \
    --cc=davem@davemloft.net \
    --cc=dsahern@kernel.org \
    --cc=edumazet@google.com \
    --cc=fw@strlen.de \
    --cc=idosch@idosch.org \
    --cc=jiri@resnulli.us \
    --cc=kuba@kernel.org \
    --cc=liuhangbin@gmail.com \
    --cc=mmuehlfe@redhat.com \
    --cc=netdev@vger.kernel.org \
    --cc=olteanv@gmail.com \
    --cc=pabeni@redhat.com \
    --cc=razor@blackwall.org \
    --cc=roopa@nvidia.com \
    --cc=stephen@networkplumber.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).