Re: [PATCH 13/18] wait: wait.h: Get rid of a kernel-doc/Sphinx warnings

Jonathan Corbet
2018-05-10T15:38:51Z

On Thu, 10 May 2018 11:21:13 -0300
Mauro Carvalho Chehab <mchehab+samsung@kernel.org> wrote:

> The problem with a hint-based mechanism is that it will generate
> false hints. If added, we may end by needing to add extra tags to
> disable the hints mechanism where it gets wrong, or to periodically
> do code changes at kernel-doc comments in order to make the hints
> logic happy.
>
> So, IMO, we should provide non-hints based mechanism, like forcing the
> string that prepends the colon to have a keyword that will make it to
> parse the block as literal, where expressions like:
>
> See the code-block foo:
> See the following code example:
> See the following flow diagram:
> See the following artwork:
>
> Is the best alternative to avoid "::", as on the enclosed patch.

But this, too, is a hint-based mechanism. Thanks for the patches, I'll
keep them around, but I would like an opportunity to try to do better
before applying them. I fear that using magic words in this way will
lead to a constant stream of surprises, and I'd like to avoid that if
possible...

Thanks,

jon