[LTP] [PATCH] readahead01.c: turn comment into docparse and reword
Cyril Hrubis
chrubis@suse.cz
Tue Jul 19 13:32:27 CEST 2022
Hi!
Pushed with fixes, thanks.
> diff --git a/testcases/kernel/syscalls/readahead/readahead01.c b/testcases/kernel/syscalls/readahead/readahead01.c
> index 4355457e9..ac762aa3e 100644
> --- a/testcases/kernel/syscalls/readahead/readahead01.c
> +++ b/testcases/kernel/syscalls/readahead/readahead01.c
> @@ -3,8 +3,13 @@
> * Copyright (C) 2012 Linux Test Project, Inc.
> */
>
> -/*
> - * errno tests for readahead() syscall
> +/*\
> + * [Description]
> + *
> + * Verify that readahead() syscall fails with
> + * - EBADF when fd is not a valid file descriptor or is not open for reading.
> + * - EINVAL when fd does not refer to a file type to which readahead()
> + * can be applied.
This does not render as a list unless there is empty line between the
"Verify that..." and the rest.
I've also added colon (:) after the "... with" as we usually do.
Please always check the resulting html pages to check if the end result
is rendered properly.
--
Cyril Hrubis
chrubis@suse.cz
More information about the ltp
mailing list