[PATCH v2 03/12] x86: Add return-value comment to cpu_jump_to_64bit()

[Simon Glass]

Hi Heinrich,

On Mon, 20 Mar 2023 at 05:19, Heinrich Schuchardt <xypron.glpk at gmx.de> wrote:
>
> On 3/10/23 21:48, Simon Glass wrote:
> > This does not mention what it returns. Add the missing documentation.
> >
> > Signed-off-by: Simon Glass <sjg at chromium.org>
> > ---
> >
> > (no changes since v1)
> >
> >   arch/x86/include/asm/cpu.h | 1 +
> >   1 file changed, 1 insertion(+)
> >
> > diff --git a/arch/x86/include/asm/cpu.h b/arch/x86/include/asm/cpu.h
> > index 3346012d335..aa03ef598e1 100644
> > --- a/arch/x86/include/asm/cpu.h
> > +++ b/arch/x86/include/asm/cpu.h
> > @@ -262,6 +262,7 @@ void cpu_call32(ulong code_seg32, ulong target, ulong table);
> >    *
> >    * @setup_base:     Pointer to the setup.bin information for the kernel
> >    * @target: Pointer to the start of the kernel image
> > + * Returns: -EFAULT if the kernel returned; otherwise does not return
>
> %s/Returns:/Return:/
>
> See https://docs.kernel.org/doc-guide/kernel-doc.html#function-documentation

Returns is more natural I think, in many contexts. It seems to support
both from my testing.

Regards,
Simon