From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S932867AbcFCUfq (ORCPT ); Fri, 3 Jun 2016 16:35:46 -0400 Received: from tex.lwn.net ([70.33.254.29]:52259 "EHLO vena.lwn.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S932603AbcFCUfk (ORCPT ); Fri, 3 Jun 2016 16:35:40 -0400 Date: Fri, 3 Jun 2016 14:35:36 -0600 From: Jonathan Corbet To: Jani Nikula Cc: Markus Heiser , Daniel Vetter , Grant Likely , Mauro Carvalho Chehab , Dan Allen , Russel Winder , Keith Packard , LKML , linux-doc@vger.kernel.org, Hans Verkuil Subject: Re: [PATCH 05/10] Documentation/sphinx: add Sphinx kernel-doc directive extension Message-ID: <20160603143536.194ff752@lwn.net> In-Reply-To: References: Organization: LWN.net X-Mailer: Claws Mail 3.13.2 (GTK+ 2.24.30; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 8bit Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Fri, 20 May 2016 16:39:36 +0300 Jani Nikula wrote: > Add an extension to handle kernel-doc directives, to call kernel-doc > according to the arguments and parameters given to the reStructuredText > directive. > > The syntax for the kernel-doc directive is: > > .. kernel-doc:: FILENAME > :export: > :internal: > :functions: FUNCTION [FUNCTION ...] > :doc: SECTION TITLE So this seems just like what the doctor ordered - nice! One little thought that has crossed my mind: it might be nice to be able to put a regex in :functions: so we could say something like: :functions: atomic_.* That requires a kernel-doc tweak too, of course. Someday. Might it be worth running this by the Sphinx list just to see what they have to say? jon