From: Cyril Hrubis <chrubis@suse.cz>
To: Petr Vorel <pvorel@suse.cz>
Cc: Linux Test Project <ltp@lists.linux.it>
Subject: Re: [LTP] [PATCH 3/4] include: Fix kernel-doc warnings in header comments
Date: Tue, 2 Jun 2026 11:04:48 +0200 [thread overview]
Message-ID: <ah6csOP7O9R0L2hO@yuki.lan> (raw)
In-Reply-To: <20260601140901.GD3391768@pevik>
Hi!
> > Downgrade kernel-doc comments to plain comments for struct tst_cmd
> > and TST_CAP() macro to avoid name collisions with the tst_cmd()
> > function and struct tst_cap respectively. The kernel-doc parser
> > flattens names case-insensitively, causing 'name used several times'
> > errors and duplicate target warnings.
>
> Hm ...
>
> ...
> > +++ b/include/tst_capability.h
> > @@ -67,7 +67,7 @@ struct tst_cap {
> > char *name;
> > };
>
> > -/**
> > +/*
> > * TST_CAP() - Create a struct tst_cap entry.
>
> This is the only warning I'd prefer to stay unfixed (i.e. it was kept in the
> docs). I wonder if we shouldn't jus rename struct or macro. Because TST_CAP()
> should be documented. Cyril @WDYT?
Looking at the resulting html pages both the structure and the function
is documented properly there. Also as long as we use c:func: and c:type:
in referencies everything should work. So I vote for ignoring this as
well.
--
Cyril Hrubis
chrubis@suse.cz
--
Mailing list info: https://lists.linux.it/listinfo/ltp
next prev parent reply other threads:[~2026-06-02 9:05 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-06-01 9:52 [LTP] [PATCH 0/4] Fix documentation issues Andrea Cervesato
2026-06-01 9:52 ` [LTP] [PATCH 1/4] doc: Fix broken references and outdated content Andrea Cervesato
2026-06-01 11:58 ` Cyril Hrubis
2026-06-01 13:55 ` Petr Vorel
2026-06-01 9:52 ` [LTP] [PATCH 2/4] doc: Fix typos and grammar Andrea Cervesato
2026-06-01 12:10 ` Cyril Hrubis
2026-06-01 13:57 ` Petr Vorel
2026-06-01 9:52 ` [LTP] [PATCH 3/4] include: Fix kernel-doc warnings in header comments Andrea Cervesato
2026-06-01 14:09 ` Petr Vorel
2026-06-02 9:04 ` Cyril Hrubis [this message]
2026-06-02 9:16 ` Andrea Cervesato via ltp
2026-06-01 9:52 ` [LTP] [PATCH 4/4] doc: Fix incorrect struct tst_test field references Andrea Cervesato
2026-06-01 14:10 ` Petr Vorel
2026-06-02 9:31 ` [LTP] [PATCH 0/4] Fix documentation issues Andrea Cervesato via ltp
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=ah6csOP7O9R0L2hO@yuki.lan \
--to=chrubis@suse.cz \
--cc=ltp@lists.linux.it \
--cc=pvorel@suse.cz \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.