Re: [PATCH 10/10] ipmi: kcs_bmc: Add subsystem kerneldoc

From: Jonathan Cameron
Date: Fri Nov 03 2023 - 11:12:42 EST


On Fri, 3 Nov 2023 16:45:22 +1030
Andrew Jeffery <andrew@xxxxxxxxxxxxxxxxxxxx> wrote:

> Provide kerneldoc describing the relationships between and the
> behaviours of the structures and functions of the KCS subsystem.
>
> Signed-off-by: Andrew Jeffery <andrew@xxxxxxxxxxxxxxxxxxxx>
Seems reasonable but I've only a superficial idea of how this all fits
together so no tag from me.

There is the fun question of whether function documentation should be
next to the implementation or in the header. As long as it's
consistent in a given subsystem I don't personally thing it matters
that much.

Jonathan