From mboxrd@z Thu Jan 1 00:00:00 1970 From: Laurent Pinchart Subject: Re: [PATCH v13 01/25] v4l: fwnode: Move KernelDoc documentation to the header Date: Tue, 19 Sep 2017 14:14:39 +0300 Message-ID: <20634394.E3nNBE0rok@avalon> References: <20170915141724.23124-1-sakari.ailus@linux.intel.com> <9077921.hsjkiRftLf@avalon> <20170919111036.5va2unwqh2vymojr@valkosipuli.retiisi.org.uk> Mime-Version: 1.0 Content-Type: text/plain; charset="iso-8859-1" Content-Transfer-Encoding: quoted-printable Return-path: In-Reply-To: <20170919111036.5va2unwqh2vymojr-S+BSfZ9RZZmRSg0ZkenSGLdO1Tsj/99ntUK59QYPAWc@public.gmane.org> Sender: devicetree-owner-u79uwXL29TY76Z2rM5mHXA@public.gmane.org To: Sakari Ailus Cc: Sakari Ailus , linux-media-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, niklas.soderlund-1zkq55x86MTxsAP9Fp7wbw@public.gmane.org, maxime.ripard-wi1+55ScJUtKEb57/3fJTNBPR1lH4CV8@public.gmane.org, robh-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org, hverkuil-qWit8jRvyhVmR6Xm/wNWPw@public.gmane.org, devicetree-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, pavel-+ZI9xUNit7I@public.gmane.org, sre-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org List-Id: devicetree@vger.kernel.org Hi Sakari, On Tuesday, 19 September 2017 14:10:37 EEST Sakari Ailus wrote: > On Tue, Sep 19, 2017 at 01:48:27PM +0300, Laurent Pinchart wrote: > > On Friday, 15 September 2017 17:17:00 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 consequently makes the V4= L2 > >> fwnode function documentation part of the Media documentation build. > >>=20 > >> Also correct the link related function and argument naming in > >> documentation. > >>=20 > >> Signed-off-by: Sakari Ailus > >> Reviewed-by: Niklas S=F6derlund > >> Acked-by: Hans Verkuil > >> Acked-by: Pavel Machek > >=20 > > I'm still very opposed to this. In addition to increasing the risk of > > documentation becoming stale, it also makes review more difficult. I'm > > reviewing patch 05/25 of this series and I have to jump around the patch > > to verify that the documentation matches the implementation, it's really > > annoying. >=20 > I'd like to have this discussion separately from the patchset, which is > right now in its 13th version. This patch simply makes the current state > consistent; V4L2 async was the only part of V4L2 with KernelDoc > documentation in .c files. But there's no need to move the documentation at this point until we reach = an=20 agreement, is there ? =2D-=20 Regards, Laurent Pinchart -- To unsubscribe from this list: send the line "unsubscribe devicetree" in the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org More majordomo info at http://vger.kernel.org/majordomo-info.html