Re: [kvm-unit-tests PATCH v1 02/10] powerpc: properly format non-kernel-doc comments

[Claudio Imbrenda <imbrenda@linux.ibm.com>]

On Mon, 06 Nov 2023 18:13:37 +0100
Nico Boehr <nrb@linux.ibm.com> wrote:

> Quoting Claudio Imbrenda (2023-11-06 17:53:16)
> > On Mon,  6 Nov 2023 13:50:58 +0100
> > Nico Boehr <nrb@linux.ibm.com> wrote:
> >   
> > > These comments do not follow the kernel-doc style, hence they should not
> > > start with /**.
> > > 
> > > Signed-off-by: Nico Boehr <nrb@linux.ibm.com>
> > > ---
> > >  powerpc/emulator.c    | 2 +-
> > >  powerpc/spapr_hcall.c | 6 +++---
> > >  powerpc/spapr_vpa.c   | 4 ++--
> > >  3 files changed, 6 insertions(+), 6 deletions(-)
> > > 
> > > diff --git a/powerpc/emulator.c b/powerpc/emulator.c
> > > index 65ae4b65e655..39dd59645368 100644
> > > --- a/powerpc/emulator.c
> > > +++ b/powerpc/emulator.c
> > > @@ -71,7 +71,7 @@ static void test_64bit(void)
> > >       report_prefix_pop();
> > >  }
> > >  
> > > -/**
> > > +/*
> > >   * Test 'Load String Word Immediate' instruction
> > >   */  
> > 
> > this should have the name of the function first: 
> >  * test_lswi() - Test 'Load String ... 
> > 
> > (same for all the other functions here)  
> 
> Since none of these comments really follow kerneldoc style and are mostly
> static anyways, the idea was to convert them to non-kerneldoc style, by
> changing the comment from:
> /**
> 
> to:
> /*
> 
> But I am just as fine to make the comments proper kerneldoc style, if we
> see value in that.

oufff yes sorry I had totally misread that