Re: [PATCH 2/3] efi: Include device-path functions in the EFI API docs

[Heinrich Schuchardt]

Am 25. Mai 2025 12:52:58 MESZ schrieb Simon Glass <sjg at chromium.org>:
>Hi Heinrich,
>
>On Sun, 25 May 2025 at 10:18, Heinrich Schuchardt <xypron.glpk at gmx.de> wrote:
>>
>> On 5/24/25 19:28, Simon Glass wrote:
>> > Include these function so they can be browsed in the API docs. Exclude
>> > END since it causes a warning, which becomes an error:
>> >
>> >     ./include/efi_device_path.h:22: warning: cannot understand function
>> >        prototype: 'const struct efi_device_path END; '
>> >
>> > Signed-off-by: Simon Glass <sjg at chromium.org>
>> > Suggested-by: Heinrich Schuchardt <xypron.glpk at gmx.de>
>>
>> We expect builds to succeed after each patch.
>>
>> In patch 1/3 you need to change '/**' to '/*' for variable END to let
>> 'make htmldocs' succeed after this patch.
>
>Thanks for resolving these.
>
>>
>> Somehow you dropped Ilias from the Cc list for the series.
>
>Ilias asked to not receive emails related to my tree. So far I don't
>have a way to cc him on some patches but not others, if he is in the
>maintainers list. If I remember, I can manually drop him from the
>patman bounce list, but then I have to remember to add him back, so I
>generally just leave it. I am thinking of adding a feature to patman
>for this though.

This is a series for addition to mainline U-Boot. Ilias should  have received it.

Patches that only apply to vendor trees or other derivatives are not what we are discussing on this mailing list.

Best regards 

Heinrich

>
>Regards,
>Simon
>
>>
>> Reviewed-by: Heinrich Schuchardt <xypron.glpk at gmx.de>
>>
>> > ---
>> >
>> > (no changes since v1)
>> >
>> >   doc/api/efi.rst           | 6 ++++++
>> >   include/efi_device_path.h | 2 +-
>> >   2 files changed, 7 insertions(+), 1 deletion(-)
>> >
>> > diff --git a/doc/api/efi.rst b/doc/api/efi.rst
>> > index 43d6f936fb0..a98298f93dc 100644
>> > --- a/doc/api/efi.rst
>> > +++ b/doc/api/efi.rst
>> > @@ -178,6 +178,12 @@ Driver binding protocol
>> >   .. kernel-doc:: include/efi_driver.h
>> >      :internal:
>> >
>> > +Device paths
>> > +------------
>> > +
>> > +.. kernel-doc:: include/efi_device_path.h
>> > +   :internal:
>> > +
>> >   Unit testing
>> >   ------------
>> >
>> > diff --git a/include/efi_device_path.h b/include/efi_device_path.h
>> > index 67474d6d0c1..33b6cfe9b79 100644
>> > --- a/include/efi_device_path.h
>> > +++ b/include/efi_device_path.h
>> > @@ -14,7 +14,7 @@ struct blk_desc;
>> >   struct efi_load_option;
>> >   struct udevice;
>> >
>> > -/**
>> > +/*
>> >    * END - Template end node for EFI device paths.
>> >    *
>> >    * Represents the terminating node of an EFI device path.
>>