Re: [PATCH 00/10] Documentation/Sphinx
From: Daniel Vetter
Date: Fri Jun 03 2016 - 16:24:16 EST
On Fri, Jun 3, 2016 at 10:16 PM, Jonathan Corbet <corbet@xxxxxxx> wrote:
>> Second, we lose support for the !C docproc directive to check
>> that all kernel-doc comments in a file are used. This is probably
>> something we'd like to have back in the future, but at this time I think
>> it's an acceptable tradeoff wrt the gains.
> This is maybe a job for a separate tool. A related issue is the (fairly
> frequent) "oh look, none of the comments in $FILE are being used"
> realization that seems to happen fairly often. It would be nice to check
> for that, but that's going to be hard to shoehorn into Sphinx.
I think much more valuable would be a tool that checks whether
comments are pulled in anywhere (for a given source file), over the
entire tree. Very often entire subsystems carg-cult kernel-doc, but
never use it in a .tmpl, which means 0-day won't notice, and neither
Software Engineer, Intel Corporation
+41 (0) 79 365 57 48 - http://blog.ffwll.ch