Re: [LTP] [PATCH] posix_fadvise: Convert docs to docparse

Petr Vorel
2025-01-15T12:45:34Z

Hi Ricardo, Shiyang Ruan,

> On Wed, Jan 15, 2025 at 06:38:13PM +0800, Shiyang Ruan via ltp wrote:
> > Signed-off-by: Shiyang Ruan <ruansy.fnst@fujitsu.com>
> > ---
> > .../kernel/syscalls/fadvise/posix_fadvise01.c | 17 +++--------------
> > .../kernel/syscalls/fadvise/posix_fadvise02.c | 17 +++--------------
> > .../kernel/syscalls/fadvise/posix_fadvise03.c | 18 ++++--------------
> > .../kernel/syscalls/fadvise/posix_fadvise04.c | 17 +++--------------
> > 4 files changed, 13 insertions(+), 56 deletions(-)

> > diff --git a/testcases/kernel/syscalls/fadvise/posix_fadvise01.c b/testcases/kernel/syscalls/fadvise/posix_fadvise01.c
> > index 71e6454d8..650459455 100644
> > --- a/testcases/kernel/syscalls/fadvise/posix_fadvise01.c
> > +++ b/testcases/kernel/syscalls/fadvise/posix_fadvise01.c
> > @@ -3,21 +3,10 @@
> > * Copyright (c) Red Hat Inc., 2007
> > */

> > -/*
> > - * NAME
> > - * posix_fadvise01.c
> > - *
> > - * DESCRIPTION
> > - * Check the value that posix_fadvise returns for wrong ADVISE value.
> > - *
> > - * USAGE
> > - * posix_fadvise01
> > - *
> > - * HISTORY
> > - * 11/2007 Initial version by Masatake YAMATO <yamato@redhat.com>

> IMHO, you could keep these 'HISTORY' lines below the copyright.

IMHO we should keep names or whatever info is there. But don't have to keep
messy formatting or original comments. I would personally keep here only:

* Author: Masatake YAMATO <yamato@redhat.com>
(it's obvious it was initial version and Red Hat copyright 2007)

or more conservative:
* Initial version by Masatake YAMATO <yamato@redhat.com>

Kind regards,
Petr