[PATCH 05/13] efi_loader: Move some memory-function comments to header

[Simon Glass]

Hi Heinrich,

On Tue, 26 Nov 2024 at 02:35, Heinrich Schuchardt <xypron.glpk at gmx.de> wrote:
>
> On 25.11.24 21:44, Simon Glass wrote:
> > Exported functions should be documented in the header file, not the
> > implementation. We tend to make such updates on a piecemeal basis to
> > avoid a 'flag day'. Move some comments related to memory allocation to
> > follow the convention.
> >
> > Signed-off-by: Simon Glass <sjg at chromium.org>
>
> Please, have a look at this line in doc/
>
> doc/api/efi.rst:78:
> .. kernel-doc:: lib/efi_loader/efi_memory.c

Hmm, we should not add C files as then we end up with all sorts of
internal functions, like checksum(). The help is a bit of a mess on
that page IMO and it could use an index at the top or side.

>
> Should we use a separate header efi_memory.h?

Yes.

>
> Best regards
>
> Heinrich
>
> > ---
> >
> >   include/efi_loader.h        | 70 ++++++++++++++++++++++++++++++++-----
> >   lib/efi_loader/efi_memory.c | 62 --------------------------------
> >   2 files changed, 62 insertions(+), 70 deletions(-)

Regards,
Simon