On Tue, Aug 29, 2017 at 04:20:10PM +0300, Sakari Ailus wrote: > Hi Laurent, > > On Tue, Aug 29, 2017 at 04:15:22PM +0300, Laurent Pinchart wrote: > > Hi Sakari, > > > > Thank you for the patch. > > > > On Tuesday, 29 August 2017 14:03:09 EEST Sakari Ailus wrote: > > > In V4L2 the practice is to have the KernelDoc documentation in the header > > > and not in .c source code files. This consequientally makes the V4L2 > > > fwnode function documentation part of the Media documentation build. > > > > > > Also correct the link related function and argument naming in > > > documentation. > > > > > > Signed-off-by: Sakari Ailus <sakari.ailus@xxxxxxxxxxxxxxx> > > > > I prefer documenting functions in the C file. Documentation in header files > > will get out-of-sync with the implementation much more easily. > > The fact is that there's very little KernelDoc documentation left in the .c > files in V4L2. This actually appears to be the only exception. And it seems > to have been in the Sphinx build; I missed that earlier, so that part of > the commit message doesn't apply. Oops. That was just a local change. So yes, the commit message is fine. -- Sakari Ailus sakari.ailus@xxxxxxxxxxxxxxx -- To unsubscribe from this list: send the line "unsubscribe devicetree" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
