[PATCH] kernel-doc: handle/strip __init

[PATCH] kernel-doc: handle/strip __init

[Randy Dunlap]

From: Randy Dunlap <randy.dunlap@oracle.com>

cc: David Brownell <dbrownell@users.sourceforge.net>

Handle __init in functions with kernel-doc notation by stripping the
__init away from the output doc.  This is already being done for
"__devinit".  This patch fixes these kernel-doc error/aborts:

Error(linux-next-20080619//drivers/usb/gadget/config.c:132): cannot understand prototype: 'struct usb_descriptor_header **__init usb_copy_descriptors(struct usb_descriptor_header **src) '
Error(linux-next-20080619//drivers/usb/gadget/config.c:182): cannot understand prototype: 'struct usb_endpoint_descriptor *__init usb_find_endpoint( 	struct usb_descriptor_header **src, 	struct usb_descriptor_header **copy, 	struct usb_endpoint_descriptor *match ) '

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
---
 scripts/kernel-doc |    1 +
 1 file changed, 1 insertion(+)

--- linux-next-20080619.orig/scripts/kernel-doc
+++ linux-next-20080619/scripts/kernel-doc
@@ -1643,6 +1643,7 @@ sub dump_function($$) {
     $prototype =~ s/^__always_inline +//;
     $prototype =~ s/^noinline +//;
     $prototype =~ s/__devinit +//;
+    $prototype =~ s/__init +//;
     $prototype =~ s/^#define\s+//; #ak added
     $prototype =~ s/__attribute__\s*\(\([a-z,]*\)\)//;
 


---
~Randy
Linux Plumbers Conference, 17-19 September 2008, Portland, Oregon USA
http://linuxplumbersconf.org/

Re: [PATCH] kernel-doc: handle/strip __init

[David Brownell]

On Thursday 19 June 2008, Randy Dunlap wrote:
> Handle __init in functions with kernel-doc notation by stripping the
> __init away from the output doc.  This is already being done for
> "__devinit".  

Right.  Shouldn't this also be done for __exit and __devexit too?

Re: [PATCH] kernel-doc: handle/strip __init

[Randy Dunlap]

--- Original Message ---
> On Thursday 19 June 2008, Randy Dunlap wrote:
> > Handle __init in functions with kernel-doc notation by stripping the
> > __init away from the output doc.  This is already being done for
> > "__devinit".  
> 
> Right.  Shouldn't this also be done for __exit and __devexit
> too?

Yes, but I generally wait until they are needed.

~Randy

Re: [PATCH] kernel-doc: handle/strip __init

[Sam Ravnborg]

On Thu, Jun 19, 2008 at 04:03:29PM -0700, Randy Dunlap wrote:
> From: Randy Dunlap <randy.dunlap@oracle.com>
> 
> cc: David Brownell <dbrownell@users.sourceforge.net>
> 
> Handle __init in functions with kernel-doc notation by stripping the
> __init away from the output doc.  This is already being done for
> "__devinit".  This patch fixes these kernel-doc error/aborts:

Applied

	Sam

Re: [PATCH] kernel-doc: handle/strip __init

[Randy Dunlap]

On Fri, 27 Jun 2008 23:05:21 +0200 Sam Ravnborg wrote:

> On Thu, Jun 19, 2008 at 04:03:29PM -0700, Randy Dunlap wrote:
> > From: Randy Dunlap <randy.dunlap@oracle.com>
> > 
> > cc: David Brownell <dbrownell@users.sourceforge.net>
> > 
> > Handle __init in functions with kernel-doc notation by stripping the
> > __init away from the output doc.  This is already being done for
> > "__devinit".  This patch fixes these kernel-doc error/aborts:
> 
> Applied

Hi Sam,

This patch is now needed so that "make *docs" does not fail.

Will you have Linus pull your tree soon or shall I send it separately?

Thanks,
---
~Randy
Linux Plumbers Conference, 17-19 September 2008, Portland, Oregon USA
http://linuxplumbersconf.org/

Re: [PATCH] kernel-doc: handle/strip __init

[Sam Ravnborg]

On Tue, Jul 22, 2008 at 01:36:05PM -0700, Randy Dunlap wrote:
> On Fri, 27 Jun 2008 23:05:21 +0200 Sam Ravnborg wrote:
> 
> > On Thu, Jun 19, 2008 at 04:03:29PM -0700, Randy Dunlap wrote:
> > > From: Randy Dunlap <randy.dunlap@oracle.com>
> > > 
> > > cc: David Brownell <dbrownell@users.sourceforge.net>
> > > 
> > > Handle __init in functions with kernel-doc notation by stripping the
> > > __init away from the output doc.  This is already being done for
> > > "__devinit".  This patch fixes these kernel-doc error/aborts:
> > 
> > Applied
> 
> Hi Sam,
> 
> This patch is now needed so that "make *docs" does not fail.
> 
> Will you have Linus pull your tree soon or shall I send it separately?

I just returned from vacation and to a restored Internet connection today.
I will prepare a pull request tonight.

	Sam