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

Ricardo B. Marliere via ltp
2025-01-15T12:32:31Z

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.

> +/*\
> + * [Description]
> *
> - * RESTRICTIONS
> - * None
> + * Verify that posix_fadvise() returns 0 for permissible ADVISE value.
> */
>
> #include <fcntl.h>
> diff --git a/testcases/kernel/syscalls/fadvise/posix_fadvise02.c b/testcases/kernel/syscalls/fadvise/posix_fadvise02.c
> index 303f776e4..39a1f1b57 100644
> --- a/testcases/kernel/syscalls/fadvise/posix_fadvise02.c
> +++ b/testcases/kernel/syscalls/fadvise/posix_fadvise02.c
> @@ -3,21 +3,10 @@
> * Copyright (c) Red Hat Inc., 2007
> */
>
> -/*
> - * NAME
> - * posix_fadvise02.c
> - *
> - * DESCRIPTION
> - * Check the value that posix_fadvise returns for wrong file descriptor.
> - *
> - * USAGE
> - * posix_fadvise02
> - *
> - * HISTORY
> - * 11/2007 Initial version by Masatake YAMATO <yamato@redhat.com>
> +/*\
> + * [Description]
> *
> - * RESTRICTIONS
> - * None
> + * Verify that posix_fadvise() returns EBADF for wrong file descriptor.
> */
>
> #include <fcntl.h>
> diff --git a/testcases/kernel/syscalls/fadvise/posix_fadvise03.c b/testcases/kernel/syscalls/fadvise/posix_fadvise03.c
> index 98d8d2930..9bfd42439 100644
> --- a/testcases/kernel/syscalls/fadvise/posix_fadvise03.c
> +++ b/testcases/kernel/syscalls/fadvise/posix_fadvise03.c
> @@ -3,21 +3,11 @@
> * Copyright (c) Red Hat Inc., 2007
> */
>
> -/*
> - * NAME
> - * posix_fadvise03.c
> - *
> - * DESCRIPTION
> - * Check the value that posix_fadvise returns for wrong ADVISE value.
> - *
> - * USAGE
> - * posix_fadvise03
> - *
> - * HISTORY
> - * 11/2007 Initial version by Masatake YAMATO <yamato@redhat.com>
> +/*\
> + * [Description]
> *
> - * RESTRICTIONS
> - * None
> + * Verify that posix_fadvise() returns EINVAL for the ADVISE value not
> + * permissible on the architecture.
> */
>
> #include <fcntl.h>
> diff --git a/testcases/kernel/syscalls/fadvise/posix_fadvise04.c b/testcases/kernel/syscalls/fadvise/posix_fadvise04.c
> index 8baf91bb0..2fe7e3577 100644
> --- a/testcases/kernel/syscalls/fadvise/posix_fadvise04.c
> +++ b/testcases/kernel/syscalls/fadvise/posix_fadvise04.c
> @@ -3,21 +3,10 @@
> * Copyright (c) Red Hat Inc., 2007
> */
>
> -/*
> - * NAME
> - * posix_fadvise04.c
> - *
> - * DESCRIPTION
> - * Check the value that posix_fadvise returns for pipe descriptor.
> - *
> - * USAGE
> - * posix_fadvise04
> - *
> - * HISTORY
> - * 11/2007 Initial version by Masatake YAMATO <yamato@redhat.com>
> +/*\
> + * [Description]
> *
> - * RESTRICTIONS
> - * None
> + * Verify that posix_fadvise() returns ESPIPE for pipe descriptor.
> */
>
> #include <fcntl.h>
> --
> 2.43.0
>
>
> --
> Mailing list info: https://lists.linux.it/listinfo/ltp