[U-Boot] [PATCH 1/1] docs: kernel-doc: fix parsing of function pointers

[U-Boot] [PATCH 1/1] docs: kernel-doc: fix parsing of function pointers

[Heinrich Schuchardt]

kernel-doc fails to parse function definitions like the one below

efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
			      void (EFIAPI *notify_function) (
					struct efi_event *event,
					void *context),
			      void *notify_context, efi_guid_t *group,
			      struct efi_event **event)
{

due to the "EFIAPI" attribute preceding the function name.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
---
I am submitted the same patch to the Kernel upstream:
https://lkml.org/lkml/2018/9/3/1185
---
 scripts/kernel-doc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 31a34ced55a3..597e3223b791 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -1381,7 +1381,7 @@ sub create_parameterlist($$$$) {
 	} elsif ($arg =~ m/\(.+\)\s*\(/) {
 	    # pointer-to-function
 	    $arg =~ tr/#/,/;
-	    $arg =~ m/[^\(]+\(\*?\s*([\w\.]*)\s*\)/;
+	    $arg =~ m/[^\(]+\([\w\s]*\*?\s*([\w\.]*)\s*\)/;
 	    $param = $1;
 	    $type = $arg;
 	    $type =~ s/([^\(]+\(\*?)\s*$param/$1/;
-- 
2.18.0

[U-Boot] [U-Boot, 1/1] docs: kernel-doc: fix parsing of function pointers

[Tom Rini]

On Mon, Sep 03, 2018 at 08:50:03PM +0200, Heinrich Schuchardt wrote:

> kernel-doc fails to parse function definitions like the one below
> 
> efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
> 			      void (EFIAPI *notify_function) (
> 					struct efi_event *event,
> 					void *context),
> 			      void *notify_context, efi_guid_t *group,
> 			      struct efi_event **event)
> {
> 
> due to the "EFIAPI" attribute preceding the function name.
> 
> Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
> ---
> I am submitted the same patch to the Kernel upstream:
> https://lkml.org/lkml/2018/9/3/1185

Looking at the lkml thread this seems to have not reached a conclusion.
Are you planning to push some v2 there that tries to address some of the
oddities there?  Or should we just make this a local correction?
Thanks!

-- 
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: <http://lists.denx.de/pipermail/u-boot/attachments/20181008/ea5bc487/attachment.sig>

[U-Boot] [U-Boot, 1/1] docs: kernel-doc: fix parsing of function pointers

[Heinrich Schuchardt]

On 10/08/2018 08:06 PM, Tom Rini wrote:
> On Mon, Sep 03, 2018 at 08:50:03PM +0200, Heinrich Schuchardt wrote:
> 
>> kernel-doc fails to parse function definitions like the one below
>>
>> efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
>> 			      void (EFIAPI *notify_function) (
>> 					struct efi_event *event,
>> 					void *context),
>> 			      void *notify_context, efi_guid_t *group,
>> 			      struct efi_event **event)
>> {
>>
>> due to the "EFIAPI" attribute preceding the function name.
>>
>> Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
>> ---
>> I am submitted the same patch to the Kernel upstream:
>> https://lkml.org/lkml/2018/9/3/1185
> 
> Looking at the lkml thread this seems to have not reached a conclusion.
> Are you planning to push some v2 there that tries to address some of the
> oddities there?  Or should we just make this a local correction?
> Thanks!
> 
Hello Tom,

I will have to rework the patch. We should stay in sync with the Linux
version.

I have marked it as "changes requested" in Patchwork now.

Best regards

Heinrich