From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1750988AbcFDNBt (ORCPT ); Sat, 4 Jun 2016 09:01:49 -0400 Received: from mga01.intel.com ([192.55.52.88]:2144 "EHLO mga01.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1750829AbcFDNBq (ORCPT ); Sat, 4 Jun 2016 09:01:46 -0400 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.26,417,1459839600"; d="scan'208";a="995141378" From: Jani Nikula To: Jonathan Corbet , Daniel Vetter Cc: Markus Heiser , Grant Likely , Mauro Carvalho Chehab , Dan Allen , Russel Winder , Keith Packard , LKML , linux-doc@vger.kernel.org, Hans Verkuil Subject: Re: [PATCH 00/10] Documentation/Sphinx In-Reply-To: <20160603142711.010cc464@lwn.net> Organization: Intel Finland Oy - BIC 0357606-4 - Westendinkatu 7, 02160 Espoo References: <20160603141618.56417305@lwn.net> <20160603142711.010cc464@lwn.net> User-Agent: Notmuch/0.22+9~g73339ad (http://notmuchmail.org) Emacs/24.4.1 (x86_64-pc-linux-gnu) Date: Sat, 04 Jun 2016 16:01:11 +0300 Message-ID: <87h9d985wo.fsf@intel.com> MIME-Version: 1.0 Content-Type: text/plain Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Fri, 03 Jun 2016, Jonathan Corbet wrote: > On Fri, 3 Jun 2016 22:24:03 +0200 > Daniel Vetter 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