diff mbox series

[3/3] link08: Convert docs to docparse

Message ID 1697021709-22916-3-git-send-email-xuyang2018.jy@fujitsu.com
State Changes Requested
Headers show
Series [1/3] link03: Convert docs to docparse | expand

Commit Message

Yang Xu Oct. 11, 2023, 10:55 a.m. UTC
Signed-off-by: Yang Xu <xuyang2018.jy@fujitsu.com>
---
 testcases/kernel/syscalls/link/link08.c | 30 +++++++++++++------------
 1 file changed, 16 insertions(+), 14 deletions(-)

Comments

Petr Vorel Oct. 12, 2023, 9:58 a.m. UTC | #1
Hi Xu,

...
> +++ b/testcases/kernel/syscalls/link/link08.c
> @@ -3,21 +3,23 @@
>   * Copyright (c) 2014 Fujitsu Ltd.
While you're in it, maybe update the copyright?

* Copyright (c) Linux Test Project, 2014-2022

>   * Author: Zeng Linggang <zenglg.jy@cn.fujitsu.com>
>   */
> -/*
> - * Test Description:
> - *  Verify that,
> - *   1. link() fails with -1 return value and sets errno to EPERM
> - *      if oldpath is a directory.
> - *   2. link() fails with -1 return value and sets errno to EXDEV
> - *      if oldpath and newpath are not on the same mounted file system( Linux
> - *      permits a file system to be mounted at multiple points, but link()
> - *      does not work across different mount points, even if the same
> - *      file system is mounted on both. ).
> - *   3. link() fails with -1 return value and sets errno to EROFS
> - *      if the file is on a read-only file system.
> - *   4. link() fails with -1 return value and sets errno to ELOOP
> - *      if too many symbolic links were encountered in resolving path.
> +
> +/*\
> + * [Description]
I would keep the sentence:
"Verify that"" or "Test that:"

Beware, there must be a blank line before the list, otherwise list will not be
formatted as list, but inline.

With this change:
Reviewed-by: Petr Vorel <pvorel@suse.cz>

Kind regards,
Petr

> + *
> + * - link() fails with -1 return value and sets errno to EPERM
> + *   if oldpath is a directory.
> + * - link() fails with -1 return value and sets errno to EXDEV
> + *   if oldpath and newpath are not on the same mounted file system( Linux
> + *   permits a file system to be mounted at multiple points, but link()
> + *   does not work across different mount points, even if the same
> + *   file system is mounted on both. ).
> + * - link() fails with -1 return value and sets errno to EROFS
> + *   if the file is on a read-only file system.
> + * - link() fails with -1 return value and sets errno to ELOOP
> + *   if too many symbolic links were encountered in resolving path.
>   */
> +
Petr Vorel Oct. 12, 2023, 10 a.m. UTC | #2
Hi Xu,

could you please fixes the formating errors and the grammar?
...
> + * - link() fails with -1 return value and sets errno to EXDEV
> + *   if oldpath and newpath are not on the same mounted file system( Linux
    *   if the old path and the new path are not on the same mounted file system (Linux

> + *   permits a file system to be mounted at multiple points, but link()
> + *   does not work across different mount points, even if the same
> + *   file system is mounted on both. ).
    *   file system is mounted on both).

Kind regards,
Petr

> + * - link() fails with -1 return value and sets errno to EROFS
> + *   if the file is on a read-only file system.
> + * - link() fails with -1 return value and sets errno to ELOOP
> + *   if too many symbolic links were encountered in resolving path.
>   */
> +
>  #include <errno.h>
>  #include "tst_test.h"
Yang Xu Oct. 13, 2023, 5:45 a.m. UTC | #3
Hi Petr,

Hi Xu,

could you please fixes the formating errors and the grammar?
...

ok.




+ * - link() fails with -1 return value and sets errno to EXDEV
+ *   if oldpath and newpath are not on the same mounted file system( Linux


    *   if the old path and the new path are not on the same mounted file system (Linux



+ *   permits a file system to be mounted at multiple points, but link()
+ *   does not work across different mount points, even if the same
+ *   file system is mounted on both. ).


    *   file system is mounted on both).

Kind regards,
Petr



+ * - link() fails with -1 return value and sets errno to EROFS
+ *   if the file is on a read-only file system.
+ * - link() fails with -1 return value and sets errno to ELOOP
+ *   if too many symbolic links were encountered in resolving path.
  */
+
 #include <errno.h>
 #include "tst_test.h"

Best Regards

Yang Xu
Yang Xu Oct. 13, 2023, 5:49 a.m. UTC | #4
Hi Petr,

Hi Xu,

...


+++ b/testcases/kernel/syscalls/link/link08.c
@@ -3,21 +3,23 @@
  * Copyright (c) 2014 Fujitsu Ltd.


While you're in it, maybe update the copyright?

* Copyright (c) Linux Test Project, 2014-2022


ok.I will update it.




  * Author: Zeng Linggang <zenglg.jy@cn.fujitsu.com><mailto:zenglg.jy@cn.fujitsu.com>
  */
-/*
- * Test Description:
- *  Verify that,
- *   1. link() fails with -1 return value and sets errno to EPERM
- *      if oldpath is a directory.
- *   2. link() fails with -1 return value and sets errno to EXDEV
- *      if oldpath and newpath are not on the same mounted file system( Linux
- *      permits a file system to be mounted at multiple points, but link()
- *      does not work across different mount points, even if the same
- *      file system is mounted on both. ).
- *   3. link() fails with -1 return value and sets errno to EROFS
- *      if the file is on a read-only file system.
- *   4. link() fails with -1 return value and sets errno to ELOOP
- *      if too many symbolic links were encountered in resolving path.
+
+/*\
+ * [Description]


I would keep the sentence:
"Verify that"" or "Test that:"

Beware, there must be a blank line before the list, otherwise list will not be
formatted as list, but inline.

With this change:
Reviewed-by: Petr Vorel <pvorel@suse.cz><mailto:pvorel@suse.cz>

Kind regards,
Petr


ok. I will correct it.




+ *
+ * - link() fails with -1 return value and sets errno to EPERM
+ *   if oldpath is a directory.
+ * - link() fails with -1 return value and sets errno to EXDEV
+ *   if oldpath and newpath are not on the same mounted file system( Linux
+ *   permits a file system to be mounted at multiple points, but link()
+ *   does not work across different mount points, even if the same
+ *   file system is mounted on both. ).
+ * - link() fails with -1 return value and sets errno to EROFS
+ *   if the file is on a read-only file system.
+ * - link() fails with -1 return value and sets errno to ELOOP
+ *   if too many symbolic links were encountered in resolving path.
  */
+

Best Regards

Yang Xu
diff mbox series

Patch

diff --git a/testcases/kernel/syscalls/link/link08.c b/testcases/kernel/syscalls/link/link08.c
index d3e33d077..b3bffb31e 100644
--- a/testcases/kernel/syscalls/link/link08.c
+++ b/testcases/kernel/syscalls/link/link08.c
@@ -3,21 +3,23 @@ 
  * Copyright (c) 2014 Fujitsu Ltd.
  * Author: Zeng Linggang <zenglg.jy@cn.fujitsu.com>
  */
-/*
- * Test Description:
- *  Verify that,
- *   1. link() fails with -1 return value and sets errno to EPERM
- *      if oldpath is a directory.
- *   2. link() fails with -1 return value and sets errno to EXDEV
- *      if oldpath and newpath are not on the same mounted file system( Linux
- *      permits a file system to be mounted at multiple points, but link()
- *      does not work across different mount points, even if the same
- *      file system is mounted on both. ).
- *   3. link() fails with -1 return value and sets errno to EROFS
- *      if the file is on a read-only file system.
- *   4. link() fails with -1 return value and sets errno to ELOOP
- *      if too many symbolic links were encountered in resolving path.
+
+/*\
+ * [Description]
+ *
+ * - link() fails with -1 return value and sets errno to EPERM
+ *   if oldpath is a directory.
+ * - link() fails with -1 return value and sets errno to EXDEV
+ *   if oldpath and newpath are not on the same mounted file system( Linux
+ *   permits a file system to be mounted at multiple points, but link()
+ *   does not work across different mount points, even if the same
+ *   file system is mounted on both. ).
+ * - link() fails with -1 return value and sets errno to EROFS
+ *   if the file is on a read-only file system.
+ * - link() fails with -1 return value and sets errno to ELOOP
+ *   if too many symbolic links were encountered in resolving path.
  */
+
 #include <errno.h>
 #include "tst_test.h"