Re: [PATCH] gpu: drm: context: Clean up documentation

From: Daniel Vetter
Date: Fri Mar 06 2020 - 04:46:12 EST


On Wed, Mar 04, 2020 at 04:42:09PM +0000, Benjamin GAIGNARD wrote:
>
>
> On 3/4/20 5:07 PM, Emil Velikov wrote:
> > On Mon, 3 Feb 2020 at 08:11, Benjamin Gaignard <benjamin.gaignard@xxxxxx> wrote:
> >> Fix kernel doc comments to avoid warnings when compiling with W=1.
> >>
> >> Signed-off-by: Benjamin Gaignard <benjamin.gaignard@xxxxxx>
> >> ---
> >> drivers/gpu/drm/drm_context.c | 145 ++++++++++++++++++------------------------
> >> 1 file changed, 61 insertions(+), 84 deletions(-)
> >>
> > Since we're talking about legacy, aka user mode-setting code, I think
> > a wiser solution is to simply remove the documentation. It is _not_
> > something we should encourage people to read, let alone use.
> >
> > Nit: prefix should be "drm:"
> Should I assume it is the same for drm_vm.c and drm_bufs.c ?

Yeah. In other legacy files all I've done is replace the /** with /* and
that's it. That shuts up kerneldoc validation for good with minimal
effort. Just not worth it to spend any time and polish on these :-)
-Daniel
--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch