On Tue, Apr 25, 2023 at 11:04:47AM +0300, Nikolay Aleksandrov wrote: > Always +1 for keeping the man pages up-to-date, but I tend to agree with > Jakub as well > that it'd be nice to have an in-kernel doc which explains the uapi and > potentially > at least some more obscure internals (if not all), we can insist on updating > it > for new changes > > I'd be happy to help fill such doc, but at the moment I don't have the > time to write the basis for it. As Hangbin nicely offered, I think we can > start > there. For a start it'd be nice to make an initial outline of the different > sections > and go on filling them from there. > > E.g. as a starter something like (feel free to edit): > Introduction > Bridge internals (fdb, timers, MTU handling, fwding decisions, ports, > synchronization) > STP (mst, rstp, timers, user-space stp etc) > Multicast (mdb, igmp, eht, vlan-mcast etc) > VLAN (filtering, options, tunnel...) > Switchdev > Netfilter > MRP/CFM (?) > FAQ > > Each of these having uapi sections with descriptions. We can include > references > to the iproute2 docs for cmd explanations and examples, but in this doc we'll > have > the uapi descriptions and maybe some helpful information about internal > implementation > that would save future contributors time. > > At the very least we can do the uapi part for each section so options are > described > and uapi nl attribute structures are explained.
OK, I will try start a draft version after the Labor holiday. Hangbin
