Skip to contentSkip to conversation

Fix tst_mkfs_ doc

PATCH In review Petr Vorel 3 participants 5 messages Jan 26, 2022 – Feb 1, 2022

lore
Share & tools
lore

Petr Vorel

author
#0 lore raw

PATCH 1/1 Fix tst_mkfs_ doc

---
 include/old/test.h | 3 ++-
 include/tst_mkfs.h | 3 ++-
 2 files changed, 4 insertions(+), 2 deletions(-)
include/old/test.h +2 -1
index 2ae7dba71f..87287a8e7e 100644
@@ -193,7 +193,8 @@ int self_exec(const char *argv0, const char *fmt, ...);
  * @dev: path to a device
  * @fs_type: filesystem type
  * @fs_opts: NULL or NULL terminated array of mkfs options
- * @extra_opt: extra mkfs option which is passed after the device name
+ * @extra_opts: NULL or NULL terminated array of extra mkfs options which is
+ * passed after the device name.
  */
 #define tst_mkfs(cleanup, dev, fs_type, fs_opts, extra_opts) \
 	tst_mkfs_(__FILE__, __LINE__, cleanup, dev, fs_type, \
include/tst_mkfs.h +2 -1
index b89bf812f6..c2d777facd 100644
@@ -9,7 +9,8 @@
  * @dev: path to a device
  * @fs_type: filesystem type
  * @fs_opts: NULL or NULL terminated array of extra mkfs options
- * @extra_opts: NULL or NULL terminated array of extra mkfs options
+ * @extra_opts: NULL or NULL terminated array of extra mkfs options which is
+ * passed after the device name.
  */
 void tst_mkfs_(const char *file, const int lineno, void (cleanup_fn)(void),
 	       const char *dev, const char *fs_type,
Signature · 5 lines
2.34.1


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
Reviewed-by on v1 1/1
#1 lore raw

Hi!

include/old/test.h int self_exec(const char *argv0, const char *fmt, ...); · line 196

Quoted 10 lines
include/old/test.h +1 -1
index 2ae7dba71f..87287a8e7e 100644
@@ -193,7 +193,8 @@ int self_exec(const char *argv0, const char *fmt, ...);
  * @dev: path to a device
  * @fs_type: filesystem type
  * @fs_opts: NULL or NULL terminated array of mkfs options
- * @extra_opt: extra mkfs option which is passed after the device name
+ * @extra_opts: NULL or NULL terminated array of extra mkfs options which is
                                                                             ^
									     are
Quoted 9 lines
include/old/test.h +1 -0
+ * passed after the device name.
  */
 #define tst_mkfs(cleanup, dev, fs_type, fs_opts, extra_opts) \
 	tst_mkfs_(__FILE__, __LINE__, cleanup, dev, fs_type, \
include/tst_mkfs.h +0 -0
index b89bf812f6..c2d777facd 100644

include/tst_mkfs.h line 12

Quoted 5 lines
include/tst_mkfs.h +1 -1
@@ -9,7 +9,8 @@
  * @dev: path to a device
  * @fs_type: filesystem type
  * @fs_opts: NULL or NULL terminated array of extra mkfs options
- * @extra_opts: NULL or NULL terminated array of extra mkfs options
+ * @extra_opts: NULL or NULL terminated array of extra mkfs options which is
                                                                             ^
									     are

include/tst_mkfs.h line 16

Quoted 4 lines
include/tst_mkfs.h +1 -0
+ * passed after the device name.
  */
 void tst_mkfs_(const char *file, const int lineno, void (cleanup_fn)(void),
 	       const char *dev, const char *fs_type,

With the minor mistake fixed:

Signature · 5 lines
Cyril Hrubis
[email protected]

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
author
#2 lore raw

Hi Cyril,

Quoted 5 lines
Quoted 3 lines

* @fs_opts: NULL or NULL terminated array of mkfs options
- * @extra_opt: extra mkfs option which is passed after the device name
+ * @extra_opts: NULL or NULL terminated array of extra mkfs options which is

                                                                             ^
									     are

I wasn't sure about the grammar, I thought the NULL *is* passed or the NULL terminated array *is* passed. But not really sure.

Kind regards,
Petr

Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
#3 lore raw

Hello,

Quoted 5 lines · Petr Vorel

Hi Cyril,

Quoted 3 lines
Quoted 3 lines

* @fs_opts: NULL or NULL terminated array of mkfs options
- * @extra_opt: extra mkfs option which is passed after the device name
+ * @extra_opts: NULL or NULL terminated array of extra mkfs options which is

Quoted 7 lines
Quoted 2 lines
                                                                             ^
									     are

I wasn't sure about the grammar, I thought the NULL *is* passed or the NULL terminated array *is* passed. But not really sure.

Kind regards,
Petr

*are* sounds more natural to me. Probably due to the order of specifying the array (singular) then its contents (plural). If you wrote something like "The extra mkfs options NULL terminated array is ...", then it would be more natural to use *is*.

Signature · 5 lines
Thank you,
Richard.

-- 
Mailing list info: https://lists.linux.it/listinfo/ltp
author
#4 lore raw

Hi Richie,

Quoted 14 lines

Hello,

Quoted 9 lines · Petr Vorel

Hi Cyril,

Quoted 5 lines
Quoted 3 lines

* @fs_opts: NULL or NULL terminated array of mkfs options
- * @extra_opt: extra mkfs option which is passed after the device name
+ * @extra_opts: NULL or NULL terminated array of extra mkfs options which is

                                                                             ^
									     are

I wasn't sure about the grammar, I thought the NULL *is* passed or the NULL terminated array *is* passed. But not really sure.

Quoted 7 lines
Quoted 2 lines

Kind regards,
Petr

*are* sounds more natural to me. Probably due to the order of specifying the array (singular) then its contents (plural). If you wrote something like "The extra mkfs options NULL terminated array is ...", then it would be more natural to use *is*.

Thanks for the explanation, merged with are.

Kind regards,
Petr

Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp