From: Petr Vorel <pvorel@suse.cz>
To: Cyril Hrubis <chrubis@suse.cz>
Cc: ltp@lists.linux.it
Subject: Re: [LTP] [PATCH v3 2/2] include: doc: Convert comments into linuxdoc
Date: Thu, 4 Apr 2024 15:42:23 +0200 [thread overview]
Message-ID: <20240404134223.GA526878@pevik> (raw)
In-Reply-To: <Zg6jOZjxGGHKkS-0@yuki>
> Hi!
> > Very nit: I would prefer if the formatting would not force the indent, e.g.:
> > * @tcnt: A number of tests. If set the test() callback is called tcnt times
> > * and each time passed an increasing counter value.
> > Because variables with long name will require more lines, but feel free to
> > ignore it.
> I do not have a strong opinion here, but I guess that we should add at
> least a single space before the subsequent lines so that it's clear that
> it's a continuation.
That's IMHO better, but feel free to ignore (it's not important).
> Does anyone else have an opinion on this?
> > > + * @options: An NULL optstr terminated array of struct tst_option.
> > > + *
> > > + * @min_kver: A minimal kernel version the test can run on. e.g. "3.10".
> > > + *
> > > + * @supported_archs: A NULL terminated array of architectures the test runs on
> > > + * e.g. {"x86_64, "x86", NULL}. Calls tst_is_on_arch() to
> > > + * check if current CPU architecture is supported and exits
> > > + * the test with TCONF if it's not.
> > > + *
> > ...
> > > void (*setup)(void);
> > > void (*cleanup)(void);
> > > -
> > > void (*test)(unsigned int test_nr);
> > > void (*test_all)(void);
> > > - /* Syscall name used by the timer measurement library */
> > We decided to drop this comment. Isn't it useful?
> > > const char *scall;
> > > -
> > > - /* Sampling function for timer measurement testcases */
> > > int (*sample)(int clk_id, long long usec);
> > And this one as well.
> The sampling is a kind of hack, I would like to rethink it a bit if it
> can't be done in a cleaner way before documenting it.
Sure, ack.
Kind regards,
Petr
--
Mailing list info: https://lists.linux.it/listinfo/ltp
prev parent reply other threads:[~2024-04-04 13:42 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-03 8:26 [LTP] [PATCH v3 0/2] doc: Add generated API docs Cyril Hrubis
2024-04-03 8:26 ` [LTP] [PATCH v3 1/2] doc: Add more to spelling_wordlist Cyril Hrubis
2024-04-04 12:38 ` Petr Vorel
2024-04-03 8:26 ` [LTP] [PATCH v3 2/2] include: doc: Convert comments into linuxdoc Cyril Hrubis
2024-04-04 12:51 ` Petr Vorel
2024-04-04 12:55 ` Cyril Hrubis
2024-04-04 13:42 ` Petr Vorel [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240404134223.GA526878@pevik \
--to=pvorel@suse.cz \
--cc=chrubis@suse.cz \
--cc=ltp@lists.linux.it \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).