Re: [PATCH v4 2/5] phy: Add LVDS configuration options

From: Liu Ying
Date: Thu Mar 25 2021 - 05:32:51 EST


Hi Vinod,

On Thu, 2021-03-25 at 12:58 +0530, Vinod Koul wrote:
> On 18-03-21, 10:22, Liu Ying wrote:
>
> > > Can we have these in kernel-doc style please, similar to style in linux/phy/phy.h
> >
> > I take this way of in-line member documentation comment for the below 3
> > reasons:
> >
> > 1) Members of struct phy_configure_opts_mipi_dphy and
> > struct phy_configure_opts_dp use the same way of comment.
> > The structures are defined in linux/phy/phy-mipi-dphy.h and
> > linux/phy/phy-dp.h respectively.
> > Aligning to them makes a bit sense, IMHO.
> >
> > 2) In-line member documentation comments[1] are mentioned in kernel-doc
> > guide. It says 'The structure members may also be documented in-line
> > within the definition.'.
> >
> > 3) Even the 'configure' and 'validate' members of struct phy_ops use
> > the same way of comment. struct phy_ops is defined in linux/phy/phy.h.
> >
> > [1]
> > https://eur01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww.kernel.org%2Fdoc%2Fhtml%2Flatest%2Fdoc-guide%2Fkernel-doc.html%23in-line-member-documentation-comments&data=04%7C01%7Cvictor.liu%40nxp.com%7C5f33165920d0484dec4d08d8ef5faabe%7C686ea1d3bc2b4c6fa92cd99c5c301635%7C0%7C0%7C637522541498852343%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=l25%2FXc0Xu2aH%2Fi7cSUqTsKae9L6BTddbhbV3vVRyON0%3D&reserved=0
>
> It 'may be' but I would like all headers of a subsystem to display one
> style. As I said linux/phy/phy.h use a style which we should use
> everywhere.

I've sent v5 out with this comment addressed.

Thanks,
Liu Ying

>
> Thanks
>