Re: [LTP] [PATCH 02/13] lib: Replace path_exist() with tst_path_exists()

Petr Vorel
2024-12-20T08:02:23Z

> Hi!
> > > diff --git a/include/tst_fs.h b/include/tst_fs.h
> > > index 835f3511c..f6ac6a40d 100644
> > > --- a/include/tst_fs.h
> > > +++ b/include/tst_fs.h
> > > @@ -145,6 +145,16 @@ int tst_dir_is_empty_(void (*cleanup)(void), const char *name, int verbose);
> > > */
> > > int tst_get_path(const char *prog_name, char *buf, size_t buf_len);

> > > +/**
> > > + * tst_path_exists()
> > nit: any short desc?

> I kind of do not like repeating the same sentence we have in the return description here.

Sure. It triggers warning:

[kernel-doc WARN] : missing initial short description of 'tst_path_exists'

I'll just ignore them (some warning mean wrong docs, this one is innocent,
also we have 145x warnings about duplicate label, thus it's not easy to see if
newly added source has proper syntax or not).

> > > + *
> > > + * @param fmt A printf-like format used to construct the path.
> > > + * @param ... A printf-like parameter list.
> > > + * @return Non-zero if path exists, zero otherwise.
> > > + */

> > Thanks for taking care of the docs. I guess this is doxygen syntax right?
> > Could you please before merge fix doc syntax - use kernel doc formatting? (no
> > param, return: and add short desc for the function).

> Sigh, yes. Will fix.

Thanks (this mean missing docs).

Kind regards,
Petr