| Message ID | 20220126164703.7177-1-pvorel@suse.cz |
|---|---|
| State | Accepted |
| Headers | show |
| Series | [1/1] Fix tst_mkfs_ doc | expand |
Hi! > diff --git a/include/old/test.h b/include/old/test.h > index 2ae7dba71f..87287a8e7e 100644 > --- a/include/old/test.h > +++ b/include/old/test.h > @@ -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 > + * passed after the device name. > */ > #define tst_mkfs(cleanup, dev, fs_type, fs_opts, extra_opts) \ > tst_mkfs_(__FILE__, __LINE__, cleanup, dev, fs_type, \ > diff --git a/include/tst_mkfs.h b/include/tst_mkfs.h > index b89bf812f6..c2d777facd 100644 > --- a/include/tst_mkfs.h > +++ b/include/tst_mkfs.h > @@ -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 > + * 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: Reviewed-by: Cyril Hrubis <chrubis@suse.cz>
Hi Cyril, > > * @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
Hello, Petr Vorel <pvorel@suse.cz> writes: > Hi Cyril, > >> > * @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 *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*.
Hi Richie, > Hello, > Petr Vorel <pvorel@suse.cz> writes: > > Hi Cyril, > >> > * @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 > *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
diff --git a/include/old/test.h b/include/old/test.h index 2ae7dba71f..87287a8e7e 100644 --- a/include/old/test.h +++ b/include/old/test.h @@ -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, \ diff --git a/include/tst_mkfs.h b/include/tst_mkfs.h index b89bf812f6..c2d777facd 100644 --- a/include/tst_mkfs.h +++ b/include/tst_mkfs.h @@ -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,
Signed-off-by: Petr Vorel <pvorel@suse.cz> --- include/old/test.h | 3 ++- include/tst_mkfs.h | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-)