* Wei Yang <richard.weiyang@xxxxxxxxx> [240830 04:47]: > On Fri, Aug 30, 2024 at 12:12:14AM -0400, Liam R. Howlett wrote: > >* Wei Yang <richard.weiyang@xxxxxxxxx> [240829 22:57]: > >> This patch tries to cleanup some interface description: > >> > >> * function name mismatch > >> * parameter name mismatch > >> * parameter all end up with ':' > >> * not prefix '*' if parameter is a pointer > > > >Why not use * if the parameter is a pointer? > > This tries to comply with kernel doc format. > > If you prefix a '*' in kenrel doc, ./scripts/kernel-doc would report a > warning. Thanks. I wanted those so that it was overly obvious when they were used wrong but I guess they have to go. > > > > >> > >> There is still some missing description of parameters, I didn't add them > >> since I am not sure the exact meaning. > >> > >> Signed-off-by: Wei Yang <richard.weiyang@xxxxxxxxx> > >> --- > >> v2: > >> * not change them to kernel doc since they are internal interface > > > >Thanks, since they are not internal interfaces, could you also change > >the patch description to state that? > > > > Sorry for the un-precise change log. > > s/interface/function/ looks good? Yes. Thanks, Liam
