Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S969735AbdI0CEL (ORCPT ); Tue, 26 Sep 2017 22:04:11 -0400 Received: from merlin.infradead.org ([205.233.59.134]:33260 "EHLO merlin.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S968076AbdI0CEI (ORCPT ); Tue, 26 Sep 2017 22:04:08 -0400 Subject: Re: [PATCH 02/10] docs: kernel-doc.rst: better describe kernel-doc arguments To: Mauro Carvalho Chehab , Linux Media Mailing List , Jonathan Corbet Cc: Mauro Carvalho Chehab , Linux Doc Mailing List , linux-kernel@vger.kernel.org, Daniel Vetter References: <66135bb9d76913c9f1515d33e731b94becbc98da.1506448061.git.mchehab@s-opensource.com> From: Randy Dunlap Message-ID: Date: Tue, 26 Sep 2017 19:04:01 -0700 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.3.0 MIME-Version: 1.0 In-Reply-To: <66135bb9d76913c9f1515d33e731b94becbc98da.1506448061.git.mchehab@s-opensource.com> Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 1190 Lines: 35 On 09/26/17 10:59, Mauro Carvalho Chehab wrote: > Add a new section to describe kernel-doc arguments, > adding examples about how identation should happen, as failing > to do that causes Sphinx to do the wrong thing. > > Signed-off-by: Mauro Carvalho Chehab > --- > Documentation/doc-guide/kernel-doc.rst | 44 +++++++++++++++++++++++++++++++--- > 1 file changed, 41 insertions(+), 3 deletions(-) > > diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst > index b24854b5d6be..7a3f5c710c0b 100644 > --- a/Documentation/doc-guide/kernel-doc.rst > +++ b/Documentation/doc-guide/kernel-doc.rst > @@ -112,16 +112,17 @@ Example kernel-doc function comment:: > > /** > * foobar() - Brief description of foobar. > - * @arg: Description of argument of foobar. > + * @argument1: Description of parameter argument1 of foobar. > + * @argument1: Description of parameter argument2 of foobar. @argument2: > * > * Longer description of foobar. > * > * Return: Description of return value of foobar. > */ > - int foobar(int arg) > + int foobar(int argument1, char *argument2) -- ~Randy