Re: [RFC Draft PATCHv2 net-next] Doc: update bridge doc

[Hangbin Liu <liuhangbin@gmail.com>]

Hi Nikolay,

On Wed, Nov 01, 2023 at 01:29:34PM +0200, Nikolay Aleksandrov wrote:
> > diff --git a/include/uapi/linux/if_link.h b/include/uapi/linux/if_link.h
> > index fac351a93aed..6adc0c70e345 100644
> > --- a/include/uapi/linux/if_link.h
> > +++ b/include/uapi/linux/if_link.h
> > @@ -461,6 +461,238 @@ enum in6_addr_gen_mode {
> >   /* Bridge section */
> > +/**
> > + * DOC: The bridge emum defination
> 
> s/emum/enum/
> 
> Below the time is not in seconds though. It is expected in clock_t (seconds
> multiplied by USER_HZ) and also exported. That should be
> better explained as it has caused confusion a lot.

I have done most of the update. But for this I'm not sure how to update.
Should I explain the clock_t defination before all the enum definations?
And how should I describe the time in the enums?
> > + *
> > + * @IFLA_BR_MCAST_LAST_MEMBER_CNT
> > + *   Set multicast last member count, ie the number of queries the bridge
> > + *   will send before stopping forwarding a multicast group after a "leave"
> > + *   message has been received.
> 
> This needs to be explained better. Remove "ie", "It is the number of queries
> the bridge will send", this part needs to be extended what are these queries
> and are they group-specific or general etc. The interval
> and time values below need better explanations of their units and what
> they represent in general. I won't add a comment below each.
> 
> Also please remove the extra new lines between the comments and the
> definitions.

And this one. Which extra new lines do you mean? Are you meaning no blank line
after each enum? e.g.

@IFLA_BR_...
  some comments
@IFLA_BR_...
  some comments

Thanks
Hangbin