On Fri, 03 Jun 2016, Jonathan Corbet <corbet@xxxxxxx> wrote: > On Fri, 3 Jun 2016 22:24:03 +0200 > Daniel Vetter <daniel.vetter@xxxxxxxx> wrote: > >> > 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 >> anyone else. > > That is kind of what I was trying to get at, yes :) For the 0-day, I've already got a preliminary kernel-doc-rst-lint script, which can be used as a checker in the kernel build. This would catch all kernel-doc comments, whether they're included to documentation or not, and complain about kernel-doc and rst issues. It won't be as comprehensive as a full Sphinx build in terms of validation, but it'll cover more kernel-doc comments. It should catch the silly errors early. BR, Jani. -- Jani Nikula, Intel Open Source Technology Center -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
