From: Greg Kurz <groug@kaod.org>
To: Christian Schoenebeck <qemu_oss@crudebyte.com>
Cc: Peter Maydell <peter.maydell@linaro.org>, qemu-devel@nongnu.org
Subject: Re: [SPAM] [PATCH] 9pfs: drop Doxygen format from qemu_dirent_dup() API comment
Date: Thu, 3 Mar 2022 10:53:32 +0100 [thread overview]
Message-ID: <20220303105332.5ce078a9@bahia> (raw)
In-Reply-To: <E1nPTwO-0006pl-Np@lizzy.crudebyte.com>
On Wed, 2 Mar 2022 19:30:39 +0100
Christian Schoenebeck <qemu_oss@crudebyte.com> wrote:
> API doc comments in QEMU are supposed to be in kerneldoc format, so drop
> occurrences of "@c" which is Doxygen format for fixed-width text.
>
> Link: https://lore.kernel.org/qemu-devel/CAFEAcA89+ENOM6x19OEF53Kd2DWkhN5SN21Va0D7yepJSa3Jyg@mail.gmail.com/
> Based-on: <E1nP9Oz-00043L-KJ@lizzy.crudebyte.com>
> Signed-off-by: Christian Schoenebeck <qemu_oss@crudebyte.com>
> ---
Sorry for not catching these during previous reviews :-\
Reviewed-by: Greg Kurz <groug@kaod.org>
FWIW it seems some more de-doxygenation is needed :
fsdev/p9array.h: * Consider the following user struct @c Foo which shall be used as scalar
fsdev/p9array.h: * @code
fsdev/p9array.h: * and assume it has the following function to free memory allocated by @c Foo
fsdev/p9array.h: * @code
fsdev/p9array.h: * @code
fsdev/p9array.h: * @code
fsdev/p9array.h: * @code
hw/9pfs/9p.h: * Lenght of the affix, that is how many (of the lowest) bits of @c value
extra nit ^^
hw/9pfs/codir.c: * @note You must @b ALWAYS call @c v9fs_free_dirents(entries) after calling
Detected with basic git grepping. Probably not exhaustive.
> hw/9pfs/9p-util.h | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/hw/9pfs/9p-util.h b/hw/9pfs/9p-util.h
> index 8b92614e6c..22835c5f61 100644
> --- a/hw/9pfs/9p-util.h
> +++ b/hw/9pfs/9p-util.h
> @@ -116,8 +116,8 @@ static inline off_t qemu_dirent_off(struct dirent *dent)
> * Duplicate directory entry @dent.
> *
> * It is highly recommended to use this function instead of open coding
> - * duplication of @c dirent objects, because the actual @c struct @c dirent
> - * size may be bigger or shorter than @c sizeof(struct dirent) and correct
> + * duplication of dirent objects, because the actual struct dirent
> + * size may be bigger or shorter than sizeof(struct dirent) and correct
> * handling is platform specific (see gitlab issue #841).
> *
> * @dent - original directory entry to be duplicated
next prev parent reply other threads:[~2022-03-03 9:55 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-03-02 18:30 [PATCH] 9pfs: drop Doxygen format from qemu_dirent_dup() API comment Christian Schoenebeck
2022-03-02 18:57 ` Peter Maydell
2022-03-03 9:53 ` Greg Kurz [this message]
2022-03-03 10:55 ` Christian Schoenebeck
2022-03-03 11:29 ` Greg Kurz
2022-03-03 12:22 ` Christian Schoenebeck
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=20220303105332.5ce078a9@bahia \
--to=groug@kaod.org \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
--cc=qemu_oss@crudebyte.com \
/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 NNTP newsgroup(s).