Re: [patch net-next 3/3] net: devlink: fix unlocked vs locked functions descriptions

Jiri Pirko
2022-07-01T16:35:31Z

Fri, Jul 01, 2022 at 06:30:37PM CEST, kuba@kernel.org wrote:
>On Fri, 1 Jul 2022 11:59:26 +0200 Jiri Pirko wrote:
>
>> + * Register devlink port with provided port index. User can use
>> + * any indexing, even hw-related one. devlink_port structure
>> + * is convenient to be embedded inside user driver private structure.
>> + * Note that the caller should take care of zeroing the devlink_port
>> + * structure.
>
>Should we also mention that the port type has to be set later?
>I guess that may be beyond the scope.

Let's do that in a separate patch. This is just to keep consistency
between devlink_ and devl_

>
>> + */
>
>> +/**
>> + * devlink_port_unregister - Unregister devlink port
>
>devl_

Right.

>
>> + *
>> + * @devlink_port: devlink port
>> + */
>
>I wonder if we should use this as an opportunity to start following
>the more modern kdoc format:
>
>No tab indentation, and () after the function's name.
>
>At least for the new kdoc we add.

Okay. Makes sense.

>
>> void devl_port_unregister(struct devlink_port *devlink_port)
>> {
>> lockdep_assert_held(&devlink_port->devlink->lock);
>