From mboxrd@z Thu Jan 1 00:00:00 1970 From: Laurent Pinchart 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> References: <1438376805-8964-1-git-send-email-danilo.cesar@collabora.co.uk> <20150801132210.2c0b84f1@lwn.net> Mime-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: base64 Return-path: In-Reply-To: <20150801132210.2c0b84f1@lwn.net> List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" To: Jonathan Corbet Cc: Michal Marek , Herbert Xu , Danilo Cesar Lemes de Paula , linux-doc@vger.kernel.org, Stephan Mueller , Daniel Vetter , intel-gfx , Randy Dunlap , linux-kernel@vger.kernel.org, dri-devel List-Id: dri-devel@lists.freedesktop.org SGkgSm9uLAoKT24gU2F0dXJkYXkgMDEgQXVndXN0IDIwMTUgMTM6MjI6MTAgSm9uYXRoYW4gQ29y YmV0IHdyb3RlOgo+IE9uIEZyaSwgMzEgSnVsIDIwMTUgMTg6MDY6NDUgLTAzMDAgRGFuaWxvIENl c2FyIExlbWVzIGRlIFBhdWxhIHdyb3RlOgo+ID4gRGVzY3JpYmluZyBhcmd1bWVudHMgYXQgdG9w IG9mIGEgc3RydWN0IGRlZmluaXRpb24gd29ya3MgZmluZQo+ID4gZm9yIHNtYWxsL21lZGl1bSBz aXplIHN0cnVjdHMsIGJ1dCBpdCBkZWZpbml0ZWx5IGRvZXNuJ3Qgd29yayB3ZWxsCj4gPiBmb3Ig c3RydWN0IHdpdGggYSBodWdlIGxpc3Qgb2YgZWxlbWVudHMuCj4gPiAKPiA+IEtlZXBpbmcgdGhl IGFyZ3VtZW50cyBsaXN0IGluc2lkZSB0aGUgc3RydWN0IGJvZHkgbWFrZXMgaXQgZWFzaWVyCj4g PiB0byBtYWludGFpbiB0aGUgZG9jdW1lbnRhdGlvbi4KPiAKPiBJbnRlcmVzdGluZyBhcHByb2Fj aC4gIEkgdGhpbmsgaXQgY291bGQgbWFrZSBzZW5zZSwgYnV0IEkgZmVhciBwdXNoYmFjawo+IGZy b20gYSBzdWJzZXQgb2YgbWFpbnRhaW5lcnMgcmVmdXNpbmcgdG8gYWNjZXB0IHRoaXMgbW9kZS4g IEkgd29uZGVyIHdoYXQKPiBpdCB3b3VsZCB0YWtlIHRvIGdldCBhIGNvbnNlbnN1cyBvbiBhbGxv d2luZyB0aGVzZSBpbi1zdHJ1Y3QgY29tbWVudHM/Cj4gCj4gSSdtIHdvbmRlcmluZyBpZiB3ZSBu ZWVkIGEga2VybmVsIHN1bW1pdCBzZXNzaW9uIG9uIGNvbW1lbnRpbmcKPiBjb252ZW50aW9ucywg bWFya2Rvd24taW4ta2VybmVsZG9jLCBldGM/ICBNYXliZSBJJ2xsIHN0aWNrIGEgcHJvcG9zYWwg b3V0Cj4gdGhlcmUuCgpUaGUgdG9waWMgb2YgZG9jdW1lbnRhdGlvbiBoYXMgYmVlbiByYWlzZWQg aW4gdGhlIG1haWwgdGhyZWFkIG9mIHRoZSBrZXJuZWwgCnJlY3J1aXRtZW50IHByb3Bvc2FsIGZv ciB0aGUga2VybmVsIHN1bW1pdC4gSSBiZWxpZXZlIGl0J3MgYW4gaW1wb3J0YW50IG9uZSwgCmFu ZCBJIHdpbGwgYmUgdmVyeSBpbnRlcmVzdGVkIGluIGNvbnRyaWJ1dGluZyBpZiBpdCBpcyBkaXNj dXNzZWQgYXMgYSBzZXBhcmF0ZSAKdG9waWMuCgotLSAKUmVnYXJkcywKCkxhdXJlbnQgUGluY2hh cnQKCl9fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fCmRyaS1k ZXZlbCBtYWlsaW5nIGxpc3QKZHJpLWRldmVsQGxpc3RzLmZyZWVkZXNrdG9wLm9yZwpodHRwOi8v bGlzdHMuZnJlZWRlc2t0b3Aub3JnL21haWxtYW4vbGlzdGluZm8vZHJpLWRldmVsCg== From mboxrd@z Thu Jan 1 00:00:00 1970 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 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