Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751288AbbHAMmk (ORCPT ); Sat, 1 Aug 2015 08:42:40 -0400 Received: from galahad.ideasonboard.com ([185.26.127.97]:59872 "EHLO galahad.ideasonboard.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751180AbbHAMmj (ORCPT ); Sat, 1 Aug 2015 08:42:39 -0400 From: Laurent Pinchart To: Jonathan Corbet Cc: Danilo Cesar Lemes de Paula , linux-doc@vger.kernel.org, Randy Dunlap , Daniel Vetter , Herbert Xu , Stephan Mueller , Michal Marek , linux-kernel@vger.kernel.org, intel-gfx , dri-devel Subject: Re: [PATCH] scripts/kernel-doc Allow struct arguments documentation in struct body Date: Sat, 01 Aug 2015 15:43:13 +0300 Message-ID: <2476993.uXUxdrudJU@avalon> User-Agent: KMail/4.14.8 (Linux/4.0.5-gentoo; KDE/4.14.8; x86_64; ; ) In-Reply-To: <20150801132210.2c0b84f1@lwn.net> References: <1438376805-8964-1-git-send-email-danilo.cesar@collabora.co.uk> <20150801132210.2c0b84f1@lwn.net> MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 1332 Lines: 34 Hi Jon, On Saturday 01 August 2015 13:22:10 Jonathan Corbet wrote: > On Fri, 31 Jul 2015 18:06:45 -0300 Danilo Cesar Lemes de Paula wrote: > > Describing arguments at top of a struct definition works fine > > for small/medium size structs, but it definitely doesn't work well > > for struct with a huge list of elements. > > > > Keeping the arguments list inside the struct body makes it easier > > to maintain the documentation. > > Interesting approach. I think it could make sense, but I fear pushback > from a subset of maintainers refusing to accept this mode. I wonder what > it would take to get a consensus on allowing these in-struct comments? > > I'm wondering if we need a kernel summit session on commenting > conventions, markdown-in-kerneldoc, etc? Maybe I'll stick a proposal out > there. The topic of documentation has been raised in the mail thread of the kernel recruitment proposal for the kernel summit. I believe it's an important one, and I will be very interested in contributing if it is discussed as a separate topic. -- Regards, Laurent Pinchart -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/