[RFC,PATCHv3,net-next,00/10] Doc: update bridge doc

Message

Hangbin Liu Nov. 10, 2023, 10:15 a.m. UTC

The current bridge kernel doc is too old. It only pointed to the
linuxfoundation wiki page which lacks of the new features.

Here let's start the new bridge document and put all the bridge info
so new developers and users could catch up the last bridge status soon.

Something I'd like to do in the future:
  - add iproute2 cmd examples for each feature

v3:
- Update netfilter part (Florian Westphal)
- Break the one large patch in to multiparts for easy reviewing. Please tell
  me if I break it too much.. (Nikolay Aleksandro)
- Update the description of each enum and doc (Nikolay Aleksandro)
- Add more descriptions for STP/Multicast/VLAN.

v2:
- Drop the python tool that generate iproute man page from kernel doc

Hangbin Liu (10):
  net: bridge: add document for IFLA_BR enum
  net: bridge: add document for IFLA_BRPORT enum
  net: bridge: add document for bridge sysfs attribute
  docs: bridge: Add kAPI/uAPI fields
  docs: bridge: add STP doc
  docs: bridge: add VLAN doc
  docs: bridge: add multicast doc
  docs: bridge: add switchdev doc
  docs: bridge: add netfilter doc
  docs: bridge: add small features

 Documentation/networking/bridge.rst | 320 +++++++++++++++++-
 include/uapi/linux/if_link.h        | 497 ++++++++++++++++++++++++++++
 net/bridge/br_sysfs_br.c            |  93 ++++++
 3 files changed, 900 insertions(+), 10 deletions(-)

Comments

Nikolay Aleksandrov Nov. 13, 2023, 9:43 a.m. UTC | #1

On 11/10/23 12:15, Hangbin Liu wrote:
> The current bridge kernel doc is too old. It only pointed to the
> linuxfoundation wiki page which lacks of the new features.
> 
> Here let's start the new bridge document and put all the bridge info
> so new developers and users could catch up the last bridge status soon.
> 
> Something I'd like to do in the future:
>    - add iproute2 cmd examples for each feature
> 
> v3:
> - Update netfilter part (Florian Westphal)
> - Break the one large patch in to multiparts for easy reviewing. Please tell
>    me if I break it too much.. (Nikolay Aleksandro)
> - Update the description of each enum and doc (Nikolay Aleksandro)

Aleksandrov :)